docs: release process: RPC documentation #14390

pull karelbilek wants to merge 1 commits into bitcoin:master from karelbilek:patch-2 changing 1 files +2 −0

karelbilek commented at 7:23 AM on October 4, 2018: contributor

The auto-generated RPC docs seem to work so far ( https://bitcoincore.org/en/doc/ + 0.17.0 https://github.com/bitcoin-core/bitcoincore.org/pull/618 ). There are some problems (the design of the list on the right is not ideal, and apparently the huge list of pages slows down jekyll), but that can be fixed later; people are already linking to the docs now and looking for them there

So I am adding the RPC docs to the release process.

The script is here and it is written in golang, since I am most confident in the language; if necessary, I can try to rewrite to python, which is more common in bitcoin tooling

https://github.com/bitcoin-core/bitcoincore.org/tree/master/contrib/doc-gen
MarcoFalke renamed this:
~~doc: RPC documentation~~
[doc] release process: RPC documentation
on Oct 4, 2018

in doc/release-process.md:298 in d847cf0580 outdated

 294 | @@ -295,6 +295,8 @@ bitcoin.org (see below for bitcoin.org update instructions).
 295 |    - Bitcoin Core announcements list https://bitcoincore.org/en/list/announcements/join/
 296 |  
 297 |    - bitcoincore.org blog post
 298 | +

MarcoFalke commented at 7:27 AM on October 4, 2018:

nit: trailing whitespace

MarcoFalke approved
MarcoFalke added the label Docs on Oct 4, 2018
doc: RPC documentation 3b706212ad
fanquake approved
promag commented at 11:45 PM on October 4, 2018: member

ACK.
ken2812221 approved
ken2812221 commented at 4:14 PM on October 6, 2018: contributor

ACK 3b706212ad319423147c9ccc681556c052050186
fanquake renamed this:
~~[doc] release process: RPC documentation~~
docs: release process: RPC documentation
on Oct 8, 2018
MarcoFalke merged this on Oct 8, 2018
MarcoFalke closed this on Oct 8, 2018
MarcoFalke referenced this in commit d6189ff200 on Oct 8, 2018
laanwj commented at 6:07 AM on October 8, 2018: member

Thanks for making this script,

though, I don't think this change is useful without a further description of how to do this release process step, not even a reference to this issue. (unless this is a note to yourself, but in that case you should likely add '(ping karel-3d)' so others can remind you when there is a release)
karelbilek commented at 6:12 AM on October 8, 2018: contributor

Good point.

But I am not sure if info about that should be added rather here or rather into bitcoin-core/bitcoincore.org git repo. (It is currently hidden in the contrib folder.)
laanwj commented at 6:13 AM on October 8, 2018: member

sure, but then there should be a link to that at least, I suppose?
Munkybooty referenced this in commit ad3b34ab61 on Jul 21, 2021
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels