From 8225ba13098398538ab916bb08a0e29aeda1b233 Mon Sep 17 00:00:00 2001 From: Will Binns Date: Sun, 26 Mar 2017 07:04:41 -0600 Subject: [PATCH 1/7] contributors: Fix formatting issue in Dave's email --- docs/become-a-contributor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/become-a-contributor.md b/docs/become-a-contributor.md index 66827d6c..20888056 100644 --- a/docs/become-a-contributor.md +++ b/docs/become-a-contributor.md @@ -33,5 +33,5 @@ Here are some ways you can help: or by filling in a [pre-made events issue](https://github.com/bitcoin-dot-org/bitcoin.org/issues/new?title=New%20event&body=%20%20%20%20-%20date%3A%20YYYY-MM-DD%0A%20%20%20%20%20%20title%3A%20%22%22%0A%20%20%20%20%20%20venue%3A%20%22%22%0A%20%20%20%20%20%20address%3A%20%22%22%0A%20%20%20%20%20%20city%3A%20%22%22%0A%20%20%20%20%20%20country%3A%20%22%22%0A%20%20%20%20%20%20link%3A%20%22%22). * Help improve Bitcoin.org another way. Email volunteer coordinators Will Binns ([will@bitcoin.org](mailto:will@bitcoin.org)) - or Dave Harding ([dave@dtrt.org](mailto: dave@dtrt.org)) to let us know how + or Dave Harding ([dave@dtrt.org](mailto:dave@dtrt.org)) to let us know how what you're interested in and how you'd like to get involved. From 9813c104c87eacfd30b56e695de0dd88fd7c2e08 Mon Sep 17 00:00:00 2001 From: Will Binns Date: Sun, 26 Mar 2017 07:06:46 -0600 Subject: [PATCH 2/7] environment: Fix formatting issue in PR link --- docs/setting-up-your-environment.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/setting-up-your-environment.md b/docs/setting-up-your-environment.md index ce86cd54..ea739662 100644 --- a/docs/setting-up-your-environment.md +++ b/docs/setting-up-your-environment.md @@ -11,8 +11,9 @@ page is refreshed. For anything more than simple text previews, you will need to build the site. If you can't do this yourself using the instructions below, please -[open a pull request][pull request] with your suggested change and one -of the site developers will create a preview for you. +[open a pull request](https://github.com/bitcoin-dot-org/bitcoin.org/compare) +with your suggested change and one of the site developers will create a preview +for you. To build the site, you need to go through a one-time installation procedure that takes 15 to 30 minutes. After that you can build the From 5777df32407d8359d7f6fed7da38e7c00b6563a8 Mon Sep 17 00:00:00 2001 From: Will Binns Date: Sun, 26 Mar 2017 07:10:21 -0600 Subject: [PATCH 3/7] code_of_conduct: Add missing period --- CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index dec356a4..98536916 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -69,7 +69,7 @@ members of the project's leadership. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 1.4, available at [http://contributor-covenant.org/version/1/4][version] +version 1.4, available at [http://contributor-covenant.org/version/1/4][version]. [homepage]: http://contributor-covenant.org [version]: http://contributor-covenant.org/version/1/4/ From e883503b86beec92fb70f3daf03e03643876e3c8 Mon Sep 17 00:00:00 2001 From: Will Binns Date: Sun, 26 Mar 2017 07:14:17 -0600 Subject: [PATCH 4/7] events_notes_alerts: Fix link and excerpt --- docs/adding-events-release-notes-and-alerts.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/adding-events-release-notes-and-alerts.md b/docs/adding-events-release-notes-and-alerts.md index f3e0304e..c73ea9d1 100644 --- a/docs/adding-events-release-notes-and-alerts.md +++ b/docs/adding-events-release-notes-and-alerts.md @@ -31,7 +31,7 @@ To create a new Bitcoin Core release, create a new file in the recommend naming it after the release, such as `0.10.0.md` Then copy in the following YAML header (the part between the three dashes, ---): -~~~ +``` --- # This file is licensed under the MIT License (MIT) available on # http://opensource.org/licenses/MIT. @@ -59,7 +59,6 @@ optional_magnetlink: ## (whitespace only) line, like the empty line before this list item. ## ## 2. Place URLs inside angle brackets, like - --- ``` @@ -91,9 +90,10 @@ is the particular version: 1. Create a new branch named `bitcoin-core-`. You can either do this locally or in GitHub's web GUI. -2. Follow the instructions in the [Release Notes][] section to create a - new release. You should leave the `optional_date` blank unless you - happen to know the date of the planned release. +2. Follow the instructions in the [Release + Notes](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/adding-events-release-notes-and-alerts.md#release-notes) + section to create a new release. You should leave the `optional_date` blank + unless you happen to know the date of the planned release. 3. Push the branch to the https://github.com/bitcoin-dot-org/bitcoin.org repository so any contributor can edit it. **Don't** open a pull From be7f7242f5e8200b7672cdffac3fe66f5b059474 Mon Sep 17 00:00:00 2001 From: Will Binns Date: Sun, 26 Mar 2017 07:18:14 -0600 Subject: [PATCH 5/7] events_notes_alerts: Fix additional snippets --- docs/adding-events-release-notes-and-alerts.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/adding-events-release-notes-and-alerts.md b/docs/adding-events-release-notes-and-alerts.md index c73ea9d1..a43f1d1a 100644 --- a/docs/adding-events-release-notes-and-alerts.md +++ b/docs/adding-events-release-notes-and-alerts.md @@ -105,21 +105,21 @@ is the particular version: being uploaded. 5. Open the failed Travis CI log. At the end, it will say something like: - +``` ERROR: Error: Could not retrieve /bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win64-setup.exe Error: Could not retrieve /bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win32-setup.exe [...] - +``` 6. Copy the errors from above into a text file and remove everything except for the URLs so that what's left are lines that look like: - +``` /bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win64-setup.exe /bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win32-setup.exe [...] - +``` 7. Optional, but nice: sort the lines into alphabetical order. 8. Now open a pull request from the `bitcoin-core-` branch to @@ -129,7 +129,7 @@ is the particular version: We recommend that you use the following text with any changes you think are appropriate. **Note:** read all the way to the end of this enumerated point before submitting your pull request. - +``` This updates the download links to point to and adds the release notes to the site. I'll keep it updated throughout the RC cycle, but it can be merged by anyone with commit access @@ -155,7 +155,7 @@ that file) Underneath the line 'Expected URLs', paste the URLs you retrieved from Travis CI earlier. - +``` Note that @laanwj is Wladimir J. van der Laan, who is usually responsible for uploading the Bitcoin Core binaries. If someone else is responsible for this release, CC them instead. If you don't From 400c0c47bd04f1297601772a5e1db509eb496057 Mon Sep 17 00:00:00 2001 From: Will Binns Date: Sun, 26 Mar 2017 07:26:27 -0600 Subject: [PATCH 6/7] events_notes_alerts: Additional formatting fixes --- .../adding-events-release-notes-and-alerts.md | 73 +++++++++---------- 1 file changed, 35 insertions(+), 38 deletions(-) diff --git a/docs/adding-events-release-notes-and-alerts.md b/docs/adding-events-release-notes-and-alerts.md index a43f1d1a..c1f5e119 100644 --- a/docs/adding-events-release-notes-and-alerts.md +++ b/docs/adding-events-release-notes-and-alerts.md @@ -106,60 +106,57 @@ is the particular version: 5. Open the failed Travis CI log. At the end, it will say something like: ``` - ERROR: - Error: Could not retrieve -/bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win64-setup.exe - Error: Could not retrieve -/bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win32-setup.exe - [...] +ERROR: +Error: Could not retrieve /bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win64-setup.exe +Error: Could not retrieve /bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win32-setup.exe +[...] ``` 6. Copy the errors from above into a text file and remove everything except for the URLs so that what's left are lines that look like: ``` - /bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win64-setup.exe - /bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win32-setup.exe - [...] +/bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win64-setup.exe +/bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win32-setup.exe +[...] ``` 7. Optional, but nice: sort the lines into alphabetical order. 8. Now open a pull request from the `bitcoin-core-` branch to the `master` branch. We recommend that you use this title: "Releases: - Add Bitcoin Core <VERSION>". + Add Bitcoin Core ". We recommend that you use the following text with any changes you think are appropriate. **Note:** read all the way to the end of this enumerated point before submitting your pull request. ``` - This updates the download links to point to and adds the - release notes to the site. I'll keep it updated throughout - the RC cycle, but it can be merged by anyone with commit access - once final is released (see TODO lists below). +This updates the download links to point to and adds the +release notes to the site. I'll keep it updated throughout the RC cycle, but it +can be merged by anyone with commit access once final is released (see +TODO lists below). - CC: @laanwj - - Essential TODO: - - * [ ] Make sure the download links work. This is automatically checked - as part of the Travis CI build, so trigger a rebuild and, if it -passes, this should be safe to merge. - - Optional TODO (may be done in commits after merge): - - * [ ] Add the actual release date to the YAML header in - `_releases/0.10.1.md` - * [ ] Add the magnet URI to the YAML header in `_releases/0.10.1.md` - (brief instructions for creating the link are provided as comments in -that file) - - Expected URLs for the Bitcoin Core binaries: - - Underneath the line 'Expected URLs', paste the URLs you retrieved - from Travis CI earlier. +CC: @laanwj ``` - Note that @laanwj is Wladimir J. van der Laan, who is usually - responsible for uploading the Bitcoin Core binaries. If someone - else is responsible for this release, CC them instead. If you don't - know who is responsible, ask in #bitcoin-dev on Freenode. + +Essential TODO: + +* [ ] Make sure the download links work. This is automatically checked as part + of the Travis CI build, so trigger a rebuild and, if it passes, this should be +safe to merge. + +Optional TODO (may be done in commits after merge): + +* [ ] Add the actual release date to the YAML header in `_releases/0.10.1.md` +* [ ] Add the magnet URI to the YAML header in `_releases/0.10.1.md` (brief + instructions for creating the link are provided as comments in that file) + +Expected URLs for the Bitcoin Core binaries: + +Underneath the line 'Expected URLs', paste the URLs you retrieved from Travis CI +earlier. + +Note that @laanwj is Wladimir J. van der Laan, who is usually responsible for +uploading the Bitcoin Core binaries. If someone else is responsible for this +release, CC them instead. If you don't know who is responsible, ask in +#bitcoin-dev on Freenode. 9. After creating the pull request, use the Labels menu to assign it the "Releases" label. This is important because it's what the Bitcoin From 346fd13b61f42864285e2f869cd881f94758a86a Mon Sep 17 00:00:00 2001 From: Will Binns Date: Sun, 26 Mar 2017 07:35:20 -0600 Subject: [PATCH 7/7] events_notes_alerts: Fix formatting of alerts docs --- .../adding-events-release-notes-and-alerts.md | 72 +++++++++---------- 1 file changed, 33 insertions(+), 39 deletions(-) diff --git a/docs/adding-events-release-notes-and-alerts.md b/docs/adding-events-release-notes-and-alerts.md index c1f5e119..97caa4aa 100644 --- a/docs/adding-events-release-notes-and-alerts.md +++ b/docs/adding-events-release-notes-and-alerts.md @@ -191,48 +191,42 @@ addresses are on the linked GitHub profiles. ). 2. Paste the following text into the top of the file: +``` +--- +## Title displayed on alert page +title: "11/12 March 2017 Chain Fork" +## Short URL for use in P2P network alerts: https://bitcoin.org/ +shorturl: "chainfork" +## Active alerts will display the banner (below) on all bitcoin.org content pages +active: true +## Banner displayed if 'active: true'. Can use HTML formatting banner: "Chain fork - Please stop mining on bitcoin version 0.14.1. Click here for more information." +## Date of the alert in YYYY-MM-DD format +date: 2017-03-11 +--- - ``` - --- - ## Title displayed on alert page - title: "11/12 March 2013 Chain Fork" - ## Short URL for use in P2P network alerts: https://bitcoin.org/ - shorturl: "chainfork" - ## Active alerts will display the banner (below) on all bitcoin.org content -pages - active: true - ## Banner displayed if 'active: true'. Can use HTML formatting - banner: "Chain fork - Please stop mining on bitcoin version 0.8.0. -Click here for more information." - ## Date of the alert in YYYY-MM-DD format - date: 2015-03-11 - --- +{% comment %} +First paragraph should indicate whose bitcoins are safe, to avoid starting a panic. +{% comment %} - {% comment %} - First paragraph should indicate whose bitcoins are safe, to avoid - starting a panic. - {% comment %} +Your bitcoins are safe if you received them in transactions confirmed before 2015-07-06 00:00 UTC. - Your bitcoins are safe if you received them in transactions - confirmed before 2015-07-06 00:00 UTC. +{% comment %} +Second paragraph should summarize the problem, and subsequent +text should indicate what people should do immediately. +Consider: users (by wallet type), merchants, and miners. +{% comment %} - {% comment %} - Second paragraph should summarize the problem, and subsequent - text should indicate what people should do immediately. - Consider: users (by wallet type), merchants, and miners. - {% comment %} +However, there has been a problem with a planned upgrade. For +bitcoins received later than the time above, confirmation scores are +significantly less reliable then they usually are for users of +certain software: - However, there has been a problem with a planned upgrade. For - bitcoins received later than the time above, confirmation scores are - significantly less reliable then they usually are for users of - certain software: +- Lightweight (SPV) wallet users should wait an additional 30 + confirmations more than you would normally wait. Electrum users, + please see this note. +``` - - Lightweight (SPV) wallet users should wait an additional 30 - confirmations more than you would normally wait. Electrum users, - please see this note. - ``` - -- Edit the file. It is written in [Markdown format][]. +- Edit the file. It is written in [Markdown format](https://guides.github.com/features/mastering-markdown/). - Commit it. @@ -263,7 +257,7 @@ The following fields may be defined in the the alert YAML header: ```yaml --- ## (Required; HTML text) Title displayed on alert page -title: "11/12 March 2013 Chain Fork" +title: "11/12 March 2017 Chain Fork" ## (Optional; display ASCII only) Short URL for use in P2P network alerts: https://bitcoin.org/ shorturl: "chainfork" @@ -272,7 +266,7 @@ all bitcoin.org content pages active: true ## (Optional; HTML text) Banner displayed if 'active: true'. Can use HTML formatting -banner: "Chain fork - Please stop mining on bitcoin version 0.8.0. Click +banner: "Chain fork - Please stop mining on bitcoin version 0.14.1. Click here for more information." ## (Optional; default=alert) CSS class to set banner color ## alert = red | warning = orange | success = green | info = blue @@ -287,7 +281,7 @@ the document: ```html
- This notice last updated: Thu, 16 May 2013 01:37:00 UTC + This notice last updated: Thu, 16 May 2017 01:37:00 UTC
```