joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 17:56:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #1551 from bitcoin-dot-org/wbnns-doc-fixes

Browse source 
Repository documentation fixes
This commit is contained in:
Will Binns 2017-03-27 14:53:16 -06:00 • committed by GitHub
commit 16c54cac37
4 changed files with 77 additions and 85 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CODE_OF_CONDUCT.md
View file

@ -69,7 +69,7 @@ members of the project's leadership.
## Attribution ## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], 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 [homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/ [version]: http://contributor-covenant.org/version/1/4/

89
docs/adding-events-release-notes-and-alerts.md
View file

@ -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` 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, ---): Then copy in the following YAML header (the part between the three dashes, ---):
~~~ ```
--- ---
# This file is licensed under the MIT License (MIT) available on # This file is licensed under the MIT License (MIT) available on
# http://opensource.org/licenses/MIT. # http://opensource.org/licenses/MIT.
@ -59,7 +59,6 @@ optional_magnetlink:
## (whitespace only) line, like the empty line before this list item. ## (whitespace only) line, like the empty line before this list item.
## ##
## 2. Place URLs inside angle brackets, like <http://bitcoin.org/bin> ## 2. Place URLs inside angle brackets, like <http://bitcoin.org/bin>
--- ---
``` ```
@ -91,9 +90,10 @@ is the particular version:
1. Create a new branch named `bitcoin-core-<VERSION>`. You can either 1. Create a new branch named `bitcoin-core-<VERSION>`. You can either
do this locally or in GitHub's web GUI. do this locally or in GitHub's web GUI.
2. Follow the instructions in the [Release Notes][] section to create a 2. Follow the instructions in the [Release
new release. You should leave the `optional_date` blank unless you Notes](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/adding-events-release-notes-and-alerts.md#release-notes)
happen to know the date of the planned release. 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 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 repository so any contributor can edit it. **Don't** open a pull
@ -105,61 +105,58 @@ is the particular version:
being uploaded. being uploaded.
5. Open the failed Travis CI log. At the end, it will say something like: 5. Open the failed Travis CI log. At the end, it will say something like:
```
ERROR: ERROR:
Error: Could not retrieve Error: Could not retrieve /bin/bitcoin-core-0.10.1/bitcoin-0.10.1-win64-setup.exe
/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: 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 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: 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-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-win32-setup.exe
[...] [...]
```
7. Optional, but nice: sort the lines into alphabetical order. 7. Optional, but nice: sort the lines into alphabetical order.
8. Now open a pull request from the `bitcoin-core-<VERSION>` branch to 8. Now open a pull request from the `bitcoin-core-<VERSION>` branch to
the `master` branch. We recommend that you use this title: "Releases: the `master` branch. We recommend that you use this title: "Releases:
Add Bitcoin Core &lt;VERSION>". Add Bitcoin Core <VERSION>".
We recommend that you use the following text with any changes you 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 think are appropriate. **Note:** read all the way to the end of this
enumerated point before submitting your pull request. enumerated point before submitting your pull request.
```
This updates the download links to point to <VERSION> and adds the This updates the download links to point to <VERSION> and adds the <VERSION>
<VERSION> release notes to the site. I'll keep it updated throughout release notes to the site. I'll keep it updated throughout the RC cycle, but it
the RC cycle, but it can be merged by anyone with commit access can be merged by anyone with commit access once <VERSION> final is released (see
once <VERSION> final is released (see TODO lists below). TODO lists below).
CC: @laanwj CC: @laanwj
```
Essential TODO: Essential TODO:
* [ ] Make sure the download links work. This is automatically checked * [ ] Make sure the download links work. This is automatically checked as part
as part of the Travis CI build, so trigger a rebuild and, if it of the Travis CI build, so trigger a rebuild and, if it passes, this should be
passes, this should be safe to merge. safe to merge.
Optional TODO (may be done in commits after merge): Optional TODO (may be done in commits after merge):
* [ ] Add the actual release date to the YAML header in * [ ] Add the actual release date to the YAML header in `_releases/0.10.1.md`
`_releases/0.10.1.md` * [ ] Add the magnet URI to the YAML header in `_releases/0.10.1.md` (brief
* [ ] Add the magnet URI to the YAML header in `_releases/0.10.1.md` instructions for creating the link are provided as comments in that file)
(brief instructions for creating the link are provided as comments in
that file)
Expected URLs for the Bitcoin Core binaries: Expected URLs for the Bitcoin Core binaries:
Underneath the line 'Expected URLs', paste the URLs you retrieved Underneath the line 'Expected URLs', paste the URLs you retrieved from Travis CI
from Travis CI earlier. earlier.
Note that @laanwj is Wladimir J. van der Laan, who is usually Note that @laanwj is Wladimir J. van der Laan, who is usually responsible for
responsible for uploading the Bitcoin Core binaries. If someone uploading the Bitcoin Core binaries. If someone else is responsible for this
else is responsible for this release, CC them instead. If you don't release, CC them instead. If you don't know who is responsible, ask in
know who is responsible, ask in #bitcoin-dev on Freenode. #bitcoin-dev on Freenode.
9. After creating the pull request, use the Labels menu to assign it the 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 "Releases" label. This is important because it's what the Bitcoin
@ -194,30 +191,24 @@ addresses are on the linked GitHub profiles.
<https://bitcoin.org/en/alert/YYYY-MM-DD-short-title>). <https://bitcoin.org/en/alert/YYYY-MM-DD-short-title>).
2. Paste the following text into the top of the file: 2. Paste the following text into the top of the file:
``` ```
--- ---
## Title displayed on alert page ## Title displayed on alert page
title: "11/12 March 2013 Chain Fork" title: "11/12 March 2017 Chain Fork"
## Short URL for use in P2P network alerts: https://bitcoin.org/<shorturl> ## Short URL for use in P2P network alerts: https://bitcoin.org/<shorturl>
shorturl: "chainfork" shorturl: "chainfork"
## Active alerts will display the banner (below) on all bitcoin.org content ## Active alerts will display the banner (below) on all bitcoin.org content pages
pages
active: true active: true
## Banner displayed if 'active: true'. Can use HTML formatting ## Banner displayed if 'active: true'. Can use HTML formatting banner: "<b>Chain fork</b> - Please stop mining on bitcoin version 0.14.1. Click here for more information."
banner: "<b>Chain fork</b> - Please stop mining on bitcoin version 0.8.0.
Click here for more information."
## Date of the alert in YYYY-MM-DD format ## Date of the alert in YYYY-MM-DD format
date: 2015-03-11 date: 2017-03-11
--- ---
{% comment %} {% comment %}
First paragraph should indicate whose bitcoins are safe, to avoid First paragraph should indicate whose bitcoins are safe, to avoid starting a panic.
starting a panic.
{% comment %} {% comment %}
Your bitcoins are safe if you received them in transactions Your bitcoins are safe if you received them in transactions confirmed before 2015-07-06 00:00 UTC.
confirmed before 2015-07-06 00:00 UTC.
{% comment %} {% comment %}
Second paragraph should summarize the problem, and subsequent Second paragraph should summarize the problem, and subsequent
@ -235,7 +226,7 @@ Click here for more information."
please see this note. 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. - Commit it.
@ -266,7 +257,7 @@ The following fields may be defined in the the alert YAML header:
```yaml ```yaml
--- ---
## (Required; HTML text) Title displayed on alert page ## (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: ## (Optional; display ASCII only) Short URL for use in P2P network alerts:
https://bitcoin.org/<shorturl> https://bitcoin.org/<shorturl>
shorturl: "chainfork" shorturl: "chainfork"
@ -275,7 +266,7 @@ all bitcoin.org content pages
active: true active: true
## (Optional; HTML text) Banner displayed if 'active: true'. Can use HTML ## (Optional; HTML text) Banner displayed if 'active: true'. Can use HTML
formatting formatting
banner: "<b>Chain fork</b> - Please stop mining on bitcoin version 0.8.0. Click banner: "<b>Chain fork</b> - Please stop mining on bitcoin version 0.14.1. Click
here for more information." here for more information."
## (Optional; default=alert) CSS class to set banner color ## (Optional; default=alert) CSS class to set banner color
## alert = red | warning = orange | success = green | info = blue ## alert = red | warning = orange | success = green | info = blue
@ -290,7 +281,7 @@ the document:
```html ```html
<div style="text-align:right"> <div style="text-align:right">
<i>This notice last updated: Thu, 16 May 2013 01:37:00 UTC</i> <i>This notice last updated: Thu, 16 May 2017 01:37:00 UTC</i>
</div> </div>
``` ```

5
docs/setting-up-your-environment.md
View file

@ -11,8 +11,9 @@ page is refreshed.
For anything more than simple text previews, you will need to build the 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 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 [open a pull request](https://github.com/bitcoin-dot-org/bitcoin.org/compare)
of the site developers will create a preview for you. 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 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 procedure that takes 15 to 30 minutes. After that you can build the