Commit graph

30 commits

Author SHA1 Message Date
David A. Harding
3499b0edad
Merge pulls #1009 and #1012
- 1009: Small Miscellaneous Backend Changes
- 1012: Create Developer Reference RPC page for gettxoutproof and verifytxoutproof
2015-08-23 10:07:07 -04:00
ChainQuery
579e4064b1
Create gettxoutproof.md and verifytxoutproof.md
Closes #1012
2015-08-23 10:04:10 -04:00
David A. Harding
0c0d979c91
Makefile updates suggested by Saïvann (thanks!) 2015-08-22 18:28:36 -04:00
David A. Harding
d0506fb227
Ensure pages in en/ use "lang: en" 2015-08-22 18:23:43 -04:00
David A. Harding
5ca3e23c38
Add gitAttributes file to treat SVGs as binary (not text)
Also prevent SVGs from containing Javascript
2015-08-22 18:23:43 -04:00
Saivann
41195a982d Add JSHint checks to the Makefile 2015-08-21 02:20:05 -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
David A. Harding
c5363552bf
Build: Put Current Git Commit ID On Site 2015-07-05 09:59:59 -04:00
Saivann
4e409097da
Use BUNDLE_DIR to define bundler's directory 2015-07-04 16:45:23 -04:00
Saivann
7013b784f3 Prevent check-for-subheading-anchors to match binary files 2015-06-26 14:38:18 -04:00
Saivann
4cb4e7e586 Support blank spaces in file names when generating sha256sums.txt 2015-06-02 12:37:04 -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
0adf79eedd
Build System: Sort Files For Consistent Comparison
Fixes problem with filenames being listed in different order on
different systems.
2015-04-23 11:26:35 -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
6a42d7b861
Backend: Makefile Targets For 'deployment' and 'travis'
* Set build server to use `make deployment`

* Create Makefile target for 'deployment' to update dependencies if
  necessary

* Set Travis CI to run `make travis`

* Create Makefile target for 'travis' to use additional automation logic
2015-04-12 14:24:32 -04:00
David A. Harding
ca7b97134d
Backend: Upgrade To Jekyll 1.3.0 & Remove Workarounds
* Require in Makefile that everyone use bundle to remove inconsistencies

* Require in Gemfile that everyone use Jekyll 1.3.*

* Require in Gemfile that everyone use Ruby 2.0.0 (already used by
  Travis and most developers)

* Remove workaround _plugin/svg.rb which showed SVG files in `jekyll
  serve` (fixed in Jekyll 1.0.0)

* Remove inconsistent file path workarounds in _plugins/autocrossref.rb
  and _plugins/inline-template.rb
2015-04-12 14:24:15 -04:00
David A. Harding
4213d102da
Style: Add anchor links to all subheads
* Adds Makefile test to ensure all subheadings, except those on Choose
  Your Wallet, have an ID (anchor reference)

* Adds an ID to all subheads that didn't have on previously
2015-04-09 11:30:28 -04:00
David A. Harding
d954708ef1
QA: Use HTML Proofer To Check Internal Links
Uses Ruby html-proofer to check the links.  This commit also fixes the
various problems it found, as well as dealing with some of its
non-problem complaints (it doesn't like anchor (a) tags without either
an href, name, or id).

Running HTML proofer takes about 12 minutes on my system (with up to two
threads), during which it prints no text. Travis CI times out after 10
minutes of nothing being written to stdout, so this commit also adds a
background process the Makefile to print a line every minute while make
runs.
2015-03-14 15:17:24 -04:00
David A. Harding
cbebe461ff Releases: Variablize Release Notes
Add additional variables to the release note files to allow setting the
version number and date.  The version number is required, and can be
used to automatically set the release notes title.  The date is optional
and can be set hours/days after the release.

Additionally, a Makefile test is added that checks whether the download
files exist on the Bitcoin.org server.  This can help prevent creating a
broken Download page.

* Set variables for all previous releases

* Document variables in README.md

* Update code and templates to use variables

* Add the Download page links to the "dl" CSS class. Also add newlines
  to make the HTML a bit easier to parse using sed

* Add a new Liquid plugin to print warnings. This is used to print a
  non-error warning if any release is created without the optional date
2015-02-27 08:15:50 -05:00
David A. Harding
584e19101c
QA: Simplify Comparison Between Local And Remote Site Files
This commit adds an extra step to the build process to SHA256 checksum
all the files that are built purely based on repository contents.  The
checksums file is uploaded to the webserver with the rest of the site
content.

A separate target is added to the Makefile to compare the remote
sha256sums file to a locally-built file to see if they differ.  This
allows us to detect when a remote build may have gone astray.
2015-02-26 07:13:47 -05:00
David A. Harding
5f532c59da
Dev Docs: Add REST Documentation
* Uses same basic format as JSON-RPC documentation.

Closes #715
2015-01-26 11:29:07 -05:00
David A. Harding
9329c69cf8
Dev Docs: Put RPC Tables In Separate CSS Class
Suggested by Saivann: RPC tables with Name/Type/Presence/Description
format are now in .ntpd CSS class so that we can format them specially.

We also change the style of all dev doc tables to replace bold table
headings (thead) with a double-line border-bottom.  This makes the
theads look less like section headings and prevents us from over-using
bold.

Minor: a Makefile warning message has been made more explicit (also
suggested by Saivann) and another Makefile rule was updated to catch
more broken tables.
2014-12-30 16:03:19 -05:00
David A. Harding
b8abfb2dcd
Dev Docs: Add 114 Pages Of New/Rewritten RPC Docs
* All previously-documented RPCs have had their text completely
  rewritten.

* All new RPCs and changed RPCs in Bitcoin Core 0.10.0 have been
  documented, except for hidden RPCs.

* A new RPC "Quick Reference" section has been added to make finding the
  right RPC easier.

* A "See Also" subsection has been added to the end of every RPC
  pointing to other relevant information.

* All previous examples in the RPC section have been re-run and updated
  as necessary.

* Syntax highlighting has been added wherever possible.

* Hash byte order has been specified as RPC byte order everywhere it's
  used in RPCs.
2014-12-24 18:46:03 -05:00
Saivann
826a6a13b7 Detect uppercase characters and punctuation marks in translation urls 2014-12-16 19:33:46 -05:00
David A. Harding
f368d38e04
Dev Docs: Add "Edit|History|Report Issue|Discuss" Links To Subheads 2014-12-13 17:35:21 -05:00
David A. Harding
37c4295fb6
Dev Docs: Revise Makefile Test To Check For Auto Links In Subheadings 2014-11-28 21:29:40 -05:00
Saivann
a9d2e73c1a Allow links in anchor affordance titles 2014-11-28 20:38:27 -05:00
David A. Harding
217ddb0701
Dev Docs (Formatting Only): Convert Fake Subheadings To Real Subheadings
Converts fake subheadings created using **bold** to real HTML
subheadings without adding them to the table of contents.

Also fixes a link broken by commit 4e067ac89e and adds a Makefile
test to catch future similar breakage.
2014-11-28 19:54:31 -05:00
David A. Harding
a149ae1f37
Dev Docs: Describe Almost All Remaining P2P Network Messages
* Describes all remaining messages except filterload. Specificially, the
  following messages are described: Addr, Alert, FilterAdd, FilterClear,
  GetAddr, Ping, Pong, Reject, VerAck, and Version

* New makefile test: report broken markdown tables

* Put relevant protocol version changes at the top of all message
  subsections.
2014-11-17 01:23:11 -05:00
David A. Harding
3a90000ed8
Add Makefile For Easy Automated Testing Immediately After Building
New Makefile lets testers build the static HTML files and then run a few
automated tests to catch problems like missing files and links.  The
Makefile is not required; the site can still be built using just Jekyll.

This commit also fixes several image-related errors reported by `make
test` by adding the missing PNG images.
2014-06-12 03:06:57 -04:00