Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Site Docs: Add Details To Alert Creation Process #962

Merged
merged 2 commits into from Jul 28, 2015

Conversation

Projects
None yet
3 participants
Contributor

harding commented Jul 14, 2015

This is, I think, the last thing left on the todo list from #934

Preview: https://github.com/harding/bitcoin.org/tree/alert-docs#alerts

@saivann saivann commented on the diff Jul 25, 2015

README.md
-```
+#### Who to Contact
+
+The following people can publish alerts on Bitcoin.org. Their email
+addresses are on the linked GitHub profiles.
+
+- Saïvann Carignan, [@saivann](https://github.com/saivann), saivann on Freenode
+- Dave Harding, [@harding](https://github.com/harding), harding on Freenode
+- Wladimir van der Laan, [@laanwj](https://github.com/laanwj), wumpus on Freenode
+- Theymos, [@theymos](https://github.com/theymos), theymos on Freenode
@saivann

saivann Jul 25, 2015

Contributor

I noticed @theymos's email address isn't on his GitHub profile as suggested above. @theymos, is it possible for you to add the information, just in case?

@theymos

theymos Jul 25, 2015

Contributor

Done.

@harding

harding Jul 25, 2015

Contributor

Thanks!

@saivann saivann commented on an outdated diff Jul 25, 2015

+
+The following people can publish alerts on Bitcoin.org. Their email
+addresses are on the linked GitHub profiles.
+
+- Saïvann Carignan, [@saivann](https://github.com/saivann), saivann on Freenode
+- Dave Harding, [@harding](https://github.com/harding), harding on Freenode
+- Wladimir van der Laan, [@laanwj](https://github.com/laanwj), wumpus on Freenode
+- Theymos, [@theymos](https://github.com/theymos), theymos on Freenode
+
+Several of the above are only occasionally on Freenode. Alert
+coordination is usually conducted in #bitcoin-dev on Freenode.
+
+#### Basic Alert
+
+1. Open your editor on a file named `_alerts/YYYY-MM-DD-short-title.md`
+ (the alert will appear as <https://bitcoin.org/YYYY-MM-DD-short-title>).
@saivann

saivann Jul 25, 2015

Contributor

@harding Found a mistake here! The url will actually be https://bitcoin.org/en/alert/YYYY-MM-DD-short-title

@saivann saivann commented on an outdated diff Jul 25, 2015

+Several of the above are only occasionally on Freenode. Alert
+coordination is usually conducted in #bitcoin-dev on Freenode.
+
+#### Basic Alert
+
+1. Open your editor on a file named `_alerts/YYYY-MM-DD-short-title.md`
+ (the alert will appear as <https://bitcoin.org/YYYY-MM-DD-short-title>).
+
+2. Paste the following text into the top of the file:
+
+ ```
+ ---
+ ## Title displayed on alert page
+ title: "11/12 March 2013 Chain Fork"
+ ## Short URL for use in P2P network alerts: https://bitcoin.org/<alias>
+ alias: "chainfork"
@saivann

saivann Jul 25, 2015

Contributor

@harding Would it be perhaps more self-explanatory to rename this variable to "shorturl" everywhere?

Edit: (And rename YYYY-MM-DD-short-title to YYYY-MM-DD-alert-title perhaps to avoid confusion)

Contributor

saivann commented Jul 25, 2015

@harding Except for the comments above, c014e92 LGTM, thanks!

harding added some commits Jul 14, 2015

Alerts: Change 'Alias' Field To 'Shorturl'
Suggested by Saïvann (thanks!)
Contributor

harding commented Jul 25, 2015

@saivann thanks for catching that mistake, and making that improvement suggestion. Here's what I've done:

  • Rebased to fix a merge conflict
  • Fixed the error
  • Changed alias to shorturl
  • Performed a full build and HTML diff to confirm that all the redirect pages were created at the same locations and that nothing else changed
Contributor

saivann commented Jul 26, 2015

Untested LGTM, thanks!

Contributor

harding commented Jul 26, 2015

@saivann thanks!

In the absence of critical feedback, this PR will be merged Tuesday.

@harding harding merged commit ec6c93e into bitcoin-dot-org:master Jul 28, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

harding added a commit that referenced this pull request Jul 28, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment