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
Merged

docs: release process: RPC documentation #14390

merged 1 commit into from Oct 8, 2018

Conversation

@karelbilek
Copy link
Contributor

@karelbilek karelbilek 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
@@ -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

Copy link
Member

@MarcoFalke MarcoFalke Oct 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: trailing whitespace

Loading

@MarcoFalke MarcoFalke added the Docs label Oct 4, 2018
@promag
Copy link
Member

@promag promag commented Oct 4, 2018

ACK.

Loading

Copy link
Contributor

@ken2812221 ken2812221 left a comment

ACK 3b70621

Loading

@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
Loading
MarcoFalke added a commit that referenced this issue Oct 8, 2018
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
Copy link
Member

@laanwj laanwj 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)

Loading

@karelbilek
Copy link
Contributor Author

@karelbilek karelbilek 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.)

Loading

@laanwj
Copy link
Member

@laanwj laanwj commented Oct 8, 2018

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

Loading

Munkybooty added a commit to Munkybooty/dash that referenced this issue Jul 21, 2021
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
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants