Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: release process: RPC documentation #14390

Merged
merged 1 commit into from Oct 8, 2018

Conversation

Projects
None yet
6 participants
@karel-3d
Copy link
Contributor

commented Oct 4, 2018

The auto-generated RPC docs seem to work so far ( https://bitcoincore.org/en/doc/ + 0.17.0 bitcoin-core/bitcoincore.org#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 MarcoFalke changed the title doc: RPC documentation [doc] release process: RPC documentation Oct 4, 2018

doc/release-process.md Outdated
@@ -295,6 +295,8 @@ bitcoin.org (see below for bitcoin.org update instructions).
- Bitcoin Core announcements list https://bitcoincore.org/en/list/announcements/join/

- bitcoincore.org blog post

This comment has been minimized.

Copy link
@MarcoFalke

MarcoFalke Oct 4, 2018

Member

nit: trailing whitespace

@MarcoFalke MarcoFalke added the Docs label Oct 4, 2018

@karel-3d karel-3d force-pushed the karel-3d:patch-2 branch to 3b70621 Oct 4, 2018

@promag

This comment has been minimized.

Copy link
Member

commented Oct 4, 2018

ACK.

@ken2812221
Copy link
Member

left a comment

ACK 3b70621

@fanquake fanquake changed the title [doc] release process: RPC documentation docs: release process: RPC documentation Oct 8, 2018

@MarcoFalke MarcoFalke merged commit 3b70621 into bitcoin:master Oct 8, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

MarcoFalke added a commit that referenced this pull request Oct 8, 2018

Merge #14390: docs: release process: RPC documentation
3b70621 doc: RPC documentation (Karel Bílek)

Pull request description:

  The auto-generated RPC docs seem to work so far ( https://bitcoincore.org/en/doc/ + 0.17.0 bitcoin-core/bitcoincore.org#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

Tree-SHA512: ba1b7696bb7ceb6cee4ff222b006b8c18768dd9283a4130751714a782d75ea2ca33f8d9fc4a5263d85a2f001c254daa0cee3b09cc7cba7366c66c5a115d8352a
@laanwj

This comment has been minimized.

Copy link
Member

commented Oct 8, 2018

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)

@karel-3d

This comment has been minimized.

Copy link
Contributor Author

commented Oct 8, 2018

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

This comment has been minimized.

Copy link
Member

commented Oct 8, 2018

sure, but then there should be a link to that at least, I suppose?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.