Commit graph

130 commits

Author SHA1 Message Date
thephez
61dcf900a6 Add doxygen config files used to generate source docs
Update misc docs
2018-01-04 10:20:25 -05:00
thephez
2e029988c9 Readme update 2017-12-07 09:09:11 -05:00
Will Binns
b9e1edb294
README: Change Bitcoin Symbol to 'Bounty' 2017-05-21 09:09:30 -06:00
Will Binns
ee4dd3a95d
README: Add section, Earn Bitcoin for Contributing 2017-05-20 11:04:54 -06:00
Will Binns
b2c36c8b47
README: Add link, Support Bitcoin.org 2017-05-13 07:13:26 -06:00
Will Binns
c53e90e811
readme: Update link, 'How to Participate' 2017-03-01 07:40:10 -06:00
Will Binns
8be964997c
docs: Update Contributing and README strings 2017-03-01 06:47:40 -06:00
Will Binns
03c1930b5f
docs: Refactor and set up Table of Contents 2017-02-28 22:01:36 -06:00
Will Binns
eb957711e5
docs: Add 'Become a Contributor' 2017-02-28 21:14:09 -06:00
Will Binns
8fcecbbbb6
docs: Add 'Blog Posts' 2017-02-28 20:57:22 -06:00
Will Binns
715ce2283a
docs: Add 'Managing Wallets' and 'Miscellaneous' 2017-02-28 20:54:20 -06:00
Will Binns
f41dfe21aa
docs: Add 'Events, Release Notes, and Alerts' 2017-02-28 20:45:09 -06:00
Will Binns
621c9a249c
docs: Add 'Assisting with Translations' 2017-02-28 20:37:57 -06:00
Will Binns
816d8e2e35
docs: Add 'Contributing to Dev Documentation' 2017-02-28 20:36:04 -06:00
Will Binns
c78a7e8449
docs: Add 'Setting up your environment' 2017-02-28 20:34:00 -06:00
Will Binns
d7a015a77b
docs: Add 'Working with GitHub' 2017-02-28 20:30:36 -06:00
Will Binns
facab11215
docs: Add links to Code of Conduct 2017-02-09 07:43:20 -06:00
Will Binns
b90e9c1ee9
README: Add link to "Watch" repository 2017-02-09 07:09:49 -06:00
Will Binns
f668901d73
README: Update Will's email address 2017-02-09 07:07:12 -06:00
Will Binns
6f8e9c15fb Merge pull request #1277 from jameshilliard/hsts-preload
add HSTS preload requirement for wallets
2016-12-21 07:02:03 -06:00
Will Binns
ac51061547 readme: Add Wallet contact, Will Binns 2016-12-18 07:27:59 -06:00
Will Binns
aa951b4eb4 readme: Add Alert contact, Will Binns 2016-12-18 07:27:59 -06:00
Will Binns
f1bae77d6c readme: Add Will, 2nd reference volunteer coord 2016-12-18 07:27:59 -06:00
Will Binns
ddd273356b readme: Translation coordinator no longer needed 2016-12-18 07:27:59 -06:00
Will Binns
41509a5162 readme: Add volunteer coordinator; Will Binns 2016-12-18 07:27:59 -06:00
James Hilliard
8d91bb76a9 Make HSTS preloading optional 2016-12-16 02:44:32 -06:00
Jonathan Cross
551a9a8a6b
README: Updating link to full node page. 2016-12-11 22:59:24 +01:00
Craig Watkins
81b024f230 Move avoiding address reuse criteria from optional to required 2016-07-04 08:43:37 -04:00
James Hilliard
ffaf884570 add HSTS preload requirement for wallets 2016-04-09 15:07:28 -05:00
David A. Harding
7d98f798ab
Upgrade to Jekyll 3.0
Gemfile:

  - Upgrade to Jekyll 3.x (3.0.1 tested).  This brings several new
    features I want to use, most notably *collections* which allows us
    to add blog-like collections. I've converted the `_releases` and
    `_alerts` pages into collections, although their plugins are
    maintained to handle the Download and Active Alert features.

  - Upgrade to latest Kramdown.

  - Lock Less at 2.4.0.  This prevents breaking our Less plugin.  Jekyll
    3.x provides native support for SCSS, so we may want to switch to
    that in time.

  - Lock HTML Proofer at 2.1.0.  The most recent version was taking
    forever to check our pages (I never actually got it to complete).
    I'll look into it when I get more time.

Makefile:

  - New `make clean` command.  Jekyll 3.x by default attempts to do
    incremental rebuilds.  The new `jekyll clean` command cleans up the
    metadata necessary for than so that a full build is performed, and
    this new `make clean` command is a wrapper around it so that we
    automatically do full rebuilds in the relevant cases.  Note: our
    plugins aren't fully compatible with the incremental rebuilds, but
    I'd like to fix that in the future.

  - Remove WEBrick hack to enable previewing with default URL paths (/
    instead of /index.html).

  - Filter out compliants from Rouge

README.md:

  - Now that Alerts (_alerts) are part of a collection, the file names
    are no longer parsed for dates, so instructions on adding the date
    to the YAML metadata have been added.

_alerts/*:

  - Now that alerts are part of a collection, the file names are no
    longer parsed to provide dates, so a `date:` field has been added to
    the YAML metadata.

_config.yml:

  - Some variables renamed per upgrade instructions.

  - Switched from old default syntax highlighter Pygments to new default
    Rouge.  I tried to use Rouge options to keep new output as similar
    to old output as possible to making diffing easy, but Rouge adds
    extra CSS class info.

  - Move `_alerts` and `_releases` into Jekyll 3.x "collections", which
    provide the organizational features we were using plugins to
    manange.  I haven't removed the old plugins because we still use
    some of their features (alerts.rb provides active issue and banner
    features; releases.rb provides info to Download page)

  - _layouts/* can no longer provide default global metadata; that is now
    provided in the new `defaults:` section in _config.yml.

_layouts/*:

  - Default metadata can no longer be provided in the layout files for
    collections, so I've removed it and left a message to see
    _config.yml.

_plugins/*:

  - Remove filter_for.rb. It's completely broken on Jekyll 3.x because
    of changes to Liquid which prevent adding new arguments to the
    inherited Liquid::For class. Existing uses of filter_for have been
    migrated to built-in for loops prefaced by sorts.

  - Remove remove-html-extension.rb: at it said in the comments, this
    was a temporary hack to get us to Jekyll 3.0.

_releases/*:

  - Rename all the files: prefix a v to the file name so the output html
    (e.g. v10.0.0.html) is the same as the source filename (e.g.
    v10.0.0.md).  This is necessary to migrate them to a Jekyll collection.

  - Remove %v from titles: we have to explicitly set the title, like we
    used to.  Again required for migration to collections.

_templates/events.html & en/rss/events.rss:

  - Sort events by date and then loop with regular for loop rather than
    filter_for

en/alerts.html & en/rss/alerts.rss:

  - Sort alerts by date and then loop with regular for loop rather than
    filter_for

en/bitcoin-core/index.md & en/version-history.html & en/rss/releases.rss:

  - Sort alerts by date and then loop with regular for loop rather than
    filter_for
2016-01-06 23:09:56 -05:00
David A. Harding
51a5e1c829
README: Apple reviewers no longer needed (Craig's got it covered) 2015-12-28 14:59:46 -05:00
David A. Harding
934043501b
Dev PGP keys: revoke Pieter Wuille's key
- Also add some hints for future maintainers about key revocation to
  README.md per discussion in PR #1120
2015-10-29 09:32:15 -04:00
Mitchell Cash
42ad10d254 Fix some spelling mistakes in README 2015-10-10 12:52:32 +10:00
David A. Harding
b035a0a619
Prevent site indexing for preview builds 2015-09-06 08:31:33 -04:00
Saivann
949c8a2ad6 Make no address reuse with change addresses a requirement for wallets 2015-07-29 00:57:56 -04:00
David A. Harding
8642c81714
Merge pull #962: Site Docs: Add Details To Alert Creation Process 2015-07-28 11:35:06 -04:00
David A. Harding
ec6c93e224
Alerts: Change 'Alias' Field To 'Shorturl'
Suggested by Saïvann (thanks!)
2015-07-25 10:18:46 -04:00
David A. Harding
b21bf33bcc
Site Docs: Add Details To Alert Creation Process
Closes #934

[skip ci]
2015-07-25 10:17:30 -04:00
David A. Harding
e038560ab7
Copyrights: Add MIT License Header To More Files
- Makefile: extend copyright check test to scan all files with YAML
  headers

    - Exclude alerts from check -- lack of a license shouldn't prevent
      us from publishing emergency information

    - Also add license to Makefile itself

- Fix all errors caught by new test

    - For release notes, also link to github.com/bitcoin/bitcoin
      repository as origin

        - Also update README.md release instructions to include license
2015-07-19 18:44:49 -04:00
Saivann
2d36e36464 Allow to set styles for alert banner 2015-07-05 21:11:23 -04:00
David A. Harding
1c817f0dd0
Site Readme: Link To More Advanced Workflow Doc 2015-06-27 17:47:51 -04:00
David A. Harding
5e7dbab508
Repository Move: Manually Update URIs 2015-06-23 09:17:03 -04:00
David A. Harding
b347044eb2
Repository Move: Update Repository URLs
git ls-tree --full-tree -r HEAD \
  | sed 's/^.\{53\}//'          \
  | xargs sed -i 's^https://github.com/bitcoin/bitcoin.org^https://github.com/bitcoin-dot-org/bitcoin.org^g'
2015-06-23 09:08:40 -04:00
David A. Harding
8e573b38f3
Merge #837, #838, and #842
* #837: Add A Blog To Bitcoin.org
* #838: Full Node Guide: Add Windows 8.x Instructions
* #842: QA: Fix 16,591 HTML Validation Errors
2015-04-28 11:06:59 -04:00
David A. Harding
d620ce61f2 Site Docs: Update release instructions
Describe how to prepare a release in advance.
2015-04-25 19:19:25 -04:00
David A. Harding
ffa9a249f3
Blog: Add Blog To Bitcoin.org
* Adds new page /en/blog

* Adds new feed for blog posts to /en/rss/blog.xml

* Adds "Blog" link to site footer

* Adds three back-dated blog posts to give the blog some initial
  content.
2015-04-22 17:49:30 -04:00
David A. Harding
a2a5f454cb
Revert "Revert "Merge pull #793: Dev Docs: New Glossary & JS Search Box""
This reverts commit 961d6c988f.
2015-04-14 08:55:53 -04:00
David A. Harding
6ffd230671
Site Docs: Grammar Fixes
Thanks Saïvann!
2015-04-13 14:30:16 -04:00
David A. Harding
3eee4811fd
Site Docs & Previews: Update Site Building/Previewing Docs
* New plugin: remove-html-extension falls back to /foo.html when /foo
  isn't found in `jekyll serve` mode.

* New Makefile target: `make preview` runs bundle exec jekyll serve

* Updated site docs to describe installing all required dependencies.
  Fully tested using a new install of Ubuntu Server 14.04.1
2015-04-12 15:20:35 -04:00
David A. Harding
961d6c988f
Revert "Merge pull #793: Dev Docs: New Glossary & JS Search Box"
This reverts commit e3dcf0ce1f, reversing
changes made to c71e9fdf2d.

Once again we had a broken new plugin that Travis CI and local building
didn't catch.
2015-04-10 19:33:39 -04:00