Commit graph

164 commits

Author SHA1 Message Date
David A. Harding
5340cb36de
Full Node Guide: Variabalize Some Paragraphs
Thanks to Wladimir for a description of the Windows/Bitcoin Core
shutdown relationship.
2015-04-24 14:21:28 -04:00
David A. Harding
547f88850e
Full Node Guide: Fix Wrong Links 2015-04-24 14:21:16 -04:00
David A. Harding
224127f2f0
Merge pulls #824 and #830
* 824: Dev Docs: Update For New 'generate' RPC
* 830: Link "quantum computing" in FAQ to related Bitcoin Magazine article
2015-04-22 17:38:44 -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
ab7ca1f26f
Dev Docs: RPCs: Add New 'generate' & Note 'getgenerate' Change 2015-04-12 20:30:59 -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
a0b206c77d
Merge pulls #765 and #770
* #765: Links: Replace Dead BitLegal.io With Wikipedia
* #770: Bitcoin for Developers: Change links
2015-02-25 11:36:44 -05:00
anduck
42072eae70
Fix typos "Bicoin" -> "Bitcoin" 2015-02-23 19:23:12 -05:00
David A. Harding
5fc487a913
Links: Replace Dead BitLegal.io With Wikipedia
BitLegal.io is no longer active, with whois saying the domain is being
deleted. As suggested by Reddit user /u/SatoshisGhost (thanks!), this
replaces the links to bitlegal with links to a Wikipedia article:

    s^http://bitlegal.io/^https://en.wikipedia.org/wiki/Legality_of_bitcoin_by_country^

If a better resource appears, we can link to that instead.
2015-02-23 14:43:16 -05:00
David A. Harding
91bd921d3e Full Node Howto: Mention Screensaver Slowdown
Mention that many OSes enter a low-power mode that's bad for Bitcoin
when their screensavers activate.

Closes #698
2015-02-19 18:29:05 -05:00
David A. Harding
83d02bdbca Full Node Howto: Merge Ubuntu Instructions Together
Suggested by Saivann Carignan (thanks!)
2015-02-19 18:29:05 -05:00
David A. Harding
4488c4dc48 Full Node Howto: Mention More Hours Better
Thanks Jameson Lopp and Saivann Carignan!
2015-02-19 18:29:05 -05:00
David A. Harding
1ba00657ae Full Node Howto: Add Windows 7, Ubuntu Server, and Other Linux
* Added instructions for Windows 7, but only for Bitcoin Core GUI. I
  added a stub for anyone who wants to write instructions for using the
  daemon on Windows.

* Added instructions for Ubuntu 14.04 LTS Server, but only for Bitcoin
  core daemon. I assume most server users run headless.

* Added instructions for Other Linux Distributions, for both GUI and
  daemon. Hopefully the instructions are general enough to apply to most
  distributions but specific enough that they actually help readers.

* Added a stub for Windows 8.1 as I don't have access to a copy, and all
  the pay-per-hour Windows VPSes I can find run some version of Windows
  Server. (I have the same problem with OS X.)

* Hid some subsections in the table of contents: I found having
  subsections named "Bitcoin Core GUI" and "...Daemon" within multiple
  sections distracting, so I hid them in the TOC.

* Added basic PGP verification instructions: I didn't try to explain PGP
  to newbies, but I did provide instructions useful to people who have
  used PGP before.  These instructions are currently displayed in the
  Windows 7 and Other Linux Distributions sections (where users download
  from Bitcoin.org).

* Made sure the end of each install section points to the Network
  Configuration section so users open port 8333.

Closes #410
2015-02-19 18:29:05 -05:00
David A. Harding
b29923a533 Full Node Howto: Add Port 8333 Instructions, Plus Corrections
Made numerous corrections suggestion by Saivann Carignan (thanks!),
including:

* Replaced GUI autostart instructions with using Bitcoin Core GUI's own
  autostart option.

* Described minimum upload speed requirements.

* Described metered bandwidth requirements. Also added a warning about
  exceeding periodic bandwidth limits.

* List items that ended with complete sentences (subject+predicate)
  received terminal punctuation. Did not terminally punctuate sentence
  fragments (sentences missing a subject or predicate).

Also suggested by Saivann, I added an extended section describing
setting up port forwarding on home routers and opening firewall ports to
allow inbound connections to port 8333.
2015-02-19 18:29:05 -05:00
David A. Harding
3c673cc338 Add Basic "How To Run A Full Node" Page
Add basic page with some general information plus instructions for
Ubuntu 14.10.

Change a link on the participate page to point to the full node page.

This page is being added as English-only for now.  I figure we can
convert it into a translation template after we have instructions for
Windows and Mac OS X, and after the instrutions have actually been
tested with the released version of Bitcoin Core 0.10.0.  (These Ubuntu
instructions were tested with RC3 and the old Ubuntu packaging.)
2015-02-19 18:29:05 -05:00
David A. Harding
2312aa10fd
Dev Docs: Merge RPC and RPC Intro
This commit merges the RPC introduction section (h4), "JSON-RPC &
bitcoin-cli" into the currently-empty RPC section (h3).  To do this, it
splits the contents of the file `_includes/ref_core_rpc_intro.md` into
the new files `_includes/ref/bitcoin-core/api-intro.md` and
`_includes/ref/bitcoin-core/rpcs/intro.md`
2015-01-27 18:40:20 -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
Saivann
f80d57b7d7 Order release history and set latest version using versions number instead of releases date 2015-01-19 15:42:49 -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
David A. Harding
8f0a80a939 Dev Docs: "Not A Specification"
Make explicit that the docs are not a specification and never will be.
2014-12-16 07:40:01 -05:00
David A. Harding
34edbe8461
Merge pull #682: Dev Docs: Add "Edit|History|Report Issue|Discuss" Links To Subheads 2014-12-16 07:13:19 -05:00
David A. Harding
53d4a6eebe
Dev Docs: Move Manual Sourcefile Lines To Auto Helper (thanks saivann!) 2014-12-14 08:12:12 -05:00
Saivann
50f5e5a1f6 Fix incorrect double quotes 2014-12-13 23:12:03 -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
Saivann
2a139a51a1 Set license files and headers for bitcoin.org's content 2014-11-21 19:09:12 -05:00
Saivann
224f67f9ec Fix broken links in devel-docs (thanks @icook) 2014-11-17 12:31:39 -05:00
Saivann
7a6484fc21 Add contextual link to source file on GitHub in devel-doc (thanks @icook @harding) 2014-11-16 23:32:58 -05:00
David A. Harding
1634212dd5
Dev Docs: Add P2P Messages That Request Or Reply With Data
Adds to the devel reference page detailed documentation on the following
messages: block, getblocks, getdata, getheaders, headers, inv, mempool,
merkleblock, notfound, and tx.

Adds to the devel examples page an example of requesting and parsing a
merkleblock message.

Adds to the devel docs overview pages links to the above two new
P2P sections.

Tweaks the autocrossref plugin ignore pattern to not crossref in the
middle of a GIF image name; this allows the inclusion of animated GIFs.
2014-11-12 12:39:36 -05:00
saivann
5417f48821 Merge pull request #621 from bitcoin/status
Display a status icon on the Network status menu entry
2014-10-30 13:05:52 -04:00
Saivann
50203f5cc4 Display a status icon on the Network status menu entry 2014-10-28 00:20:58 -04:00
Saivann
d29b451a93 Translate, update and reposition press page 2014-10-27 23:10:40 -04:00
David A. Harding
e65d86de21
Mention Bitcoin's RPC Hash Byte Order
* Add a short subsection about the different byte orders used with
  hashes in Bitcoin Core and other software.

* Re-word some text in other sections to mention the byte order
  differences

This commit created based on comments from @SergioDemianLerner (thanks!)
2014-10-23 14:53:52 -04:00
Saivann
5cf4029368 Fix redirected links 2014-08-22 00:49:36 -04:00
David A. Harding
2b0c46c761
Update Name & Link For Okupski Developer Reference At @minium's request 2014-07-23 08:52:28 -04:00
Saivann
ffed3c2529 Create a "Testing Applications" subsection in devel-examples
Move existing "regtest / testnet" texts to the new subsection and link to it
Move Bitcoin Core setup instructions in devel-examples
Add a consistent introduction for devel-(guide/ref/examples)
Fix autocrossref.rb to not add links inside {% highlight %} code blocks
2014-06-12 21:42:42 -04:00
David A. Harding
b428cbde26
Merge remote-tracking branch 'harding/generatingtxes' 2014-06-10 13:51:59 -04:00
Saivann
f7f25abcaa Fix RSS feed to pass W3C validation (fixes #446) 2014-06-09 15:03:18 -04:00
Saivann
ca7b38d5ea Use consistent names for 48px icons 2014-06-07 15:13:11 -04:00
Saivann
9ef9eedff4 Fix "Return To Overview" icon in devel-example 2014-06-07 14:07:35 -04:00
Saivann
2cc5d241e5 Use consistent capitalization for devel-doc icons 2014-06-07 14:07:02 -04:00
David A. Harding
c4c52cf896
Add Report Issue Link To Developer Examples 2014-06-07 09:40:43 -04:00
David A. Harding
617213a980
Add Disclaimer & Anchor Affordance To Dev Examples 2014-06-02 13:07:27 -04:00
David A. Harding
78b4c5452e
Merge remote-tracking branch 'bitcoin.org/master' into generatingtxes
Conflicts:
	_includes/guide_payment_processing.md
	_less/screen.less
2014-06-02 11:40:38 -04:00
David A. Harding
2e2b0968e7
Add Icons; Update Links
* Add new icons for Developer Guide and Developer Examples so we don't
  keep reusing the book icon.

* Update payment protocol links to point to developer examples when
  appropriate.
2014-06-02 11:30:53 -04:00
David A. Harding
7e8e52b966
Move BIP70 Example To Dev Examples
* Move the extened BIP70 example from the guide to the developer
  examples page.

* Add new text introducing BIP70 to the guide
2014-06-01 20:12:31 -04:00
David A. Harding
d1b4b08729
Add Developer Examples; Transaction Tutorial
* Add new Developer Examples page

* Add a transaction tutorial describing in detail how to make various
  different transactions.

* Add a new "multicode" CSS class to allow combination of consecutive
  code blocks into a single code block. This lets us use pygments
  highlighting for multiple different types of code within the same
  aparent block of code.

* Get autocrossref to ignore code blocks so we don't need to endcrossref
  every time we encounter a code block. This makes the source much more
  readable and maintainable.
2014-05-29 23:19:57 -04:00
saivann
5edf81fde5 Merge pull request #423 from bitcoin/devel-resources
Add "Additional Resources" subsection in devel-docs
2014-05-26 10:39:21 -04:00