From 8fcecbbbb66108413c8f860b26d616a114fae48d Mon Sep 17 00:00:00 2001 From: Will Binns Date: Tue, 28 Feb 2017 20:57:22 -0600 Subject: [PATCH] docs: Add 'Blog Posts' --- README.md | 43 --------------------------------------- docs/adding-blog-posts.md | 33 ++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 43 deletions(-) create mode 100644 docs/adding-blog-posts.md diff --git a/README.md b/README.md index 027382cc1f..516cff2812 100644 --- a/README.md +++ b/README.md @@ -60,49 +60,6 @@ You can always report problems or help improve bitcoin.org by opening a [new iss [full node page]: https://bitcoin.org/en/full-node [write new documentation]: #developer-documentation -### Blog Posts - -Posts for the [Bitcoin.org Site Blog][] should be added to the `_posts` -directory with the naming convention: -`YEAR-MONTH-DAY-ARBITRARY_FILE_NAME` (with year, month, and day as -two-digit numbers). The YAML front matter should be similar to this: - - --- - type: posts - layout: post - lang: en - category: blog - - title: "Quarterly Report March 2015" - permalink: /en/posts/quarterly-report-march-2015.html - date: 2015-03-05 - author: > - David A. Harding (email, GitHub, - Reddit) - --- - -The type, layout, and category should always be as specified above. The -other parameters should be set to values specific to that post, but the -permalink must end in '.html'. - -Below the YAML front matter, enter the content of the post in Markdown -format. Images should be placed in `img/blog/free` if they are -MIT-licensed or `img/blog/nonfree` if they have a more restrictive -copyright license. - -### Developer PGP keys - -The site hosts the PGP keys for several Bitcoin Core contributors. Here -are some notes about updating those keys based on previous experience: - -1. If a key is revoked, update the key with the revocation immediately. - Anyone with commit access to the site repository may do this without - prior review, but they should post the commit ID to an open issue or - PR so other people can review it. After the revoked key is uploaded, - discussion about verifying/adding a replacement key may continue at a - slower pace. - ### Code of Conduct Contributors to Bitcoin.org are expected to adhere to the project's [Code of diff --git a/docs/adding-blog-posts.md b/docs/adding-blog-posts.md new file mode 100644 index 0000000000..baf7f099c9 --- /dev/null +++ b/docs/adding-blog-posts.md @@ -0,0 +1,33 @@ +## Blog Posts + +Posts for the [Bitcoin.org Site Blog][] should be added to the `_posts` +directory with the naming convention: +`YEAR-MONTH-DAY-ARBITRARY_FILE_NAME` (with year, month, and day as +two-digit numbers). The YAML front matter should be similar to this: + + --- + type: posts + layout: post + lang: en + category: blog + + title: "Quarterly Report March 2015" + permalink: /en/posts/quarterly-report-march-2015.html + date: 2015-03-05 + author: > + David A. Harding (email, GitHub, + Reddit) + --- + +The type, layout, and category should always be as specified above. The +other parameters should be set to values specific to that post, but the +permalink must end in '.html'. + +Below the YAML front matter, enter the content of the post in Markdown +format. Images should be placed in `img/blog/free` if they are +MIT-licensed or `img/blog/nonfree` if they have a more restrictive +copyright license. + +**Questions?** +Contact Will Binns for help.