Autogen docs for the "Configuring Parity Ethereum" wiki page. #10067

jam10o-new · 2018-12-14T14:40:32Z

Working on the js side of this atm.

parity-cla-bot · 2018-12-14T14:40:35Z

It looks like @joshua-mir signed our Contributor License Agreement. 👍

Many thanks,

Parity Technologies CLA Bot

jam10o-new · 2018-12-24T11:42:57Z

depends on: paritytech/parity-config-generator#47

tomusdrw

Cool!

tomusdrw · 2018-12-27T10:03:14Z

scripts/gitlab/publish-docs.sh

+    echo "_______Build config docs______"
+    npm install
+    npm run generate-data
+    npm run generate-docs


Seems that this script will actually always use latest commit from master. In future it might be better to just use the checked out cli/mod.rs instead of having parity-config-generator fetching another one from master.

I went ahead and got this working 👍

Awesome 🎉 :)

adding an environment variable so js knows not to download git master and just grab the local repo

made some changes making this unnecessary

env variable passes to node properly now

tomusdrw

Looks good!

tomusdrw · 2018-12-27T14:27:34Z

scripts/gitlab/publish-docs.sh

@@ -15,12 +16,19 @@ build_docs() {
    npm run build:markdown
 }

+build_config() {
+    echo "_______Build config docs______"
+    npm install


Just noticed that parity-config-generator is using yarn (there is a yarn.lock there). Might be good to use yarn here as well (if available) so that we have the pinned versions while we install.

it should be one or the other, right? should I use yarn install or npm install?

Yeah, I think we should use yarn install (if available in the docker image)

@joshua-mir let me know if any docker changes are required to use yarn.

@ddorgan I'm still not super clear which image this runs in and where this script is run exactly, 😅 - yarn should just need an npm install -g yarn or the same in whatever package manager we have access to?

scripts/gitlab/publish-docs.sh

jam10o-new · 2019-01-04T17:03:38Z

https://github.com/paritytech/wiki/compare/rpcdoc-update-pr-10067 seems to be the output of this currently
@Tbaut do you know why un is back in the rpc docs? 😢

edit: Ah, looks like that issue was never fixed. It's probably something outside the scope of this pr 😅

reverting testing changes

Very unlikely to be important/useful

scripts/gitlab/publish-docs.sh

TriplEight · 2019-01-03T21:09:07Z

scripts/gitlab/publish-docs.sh

+build_config() {
+    echo "_______Build config docs______"
+    yarn install
+    AUTOGENSCRIPT=1 yarn generate-docs


https://gitlab.parity.io/parity/parity-ethereum/-/jobs/114444

to make it easier to debug, each commit to this branch goes compiling, and you can check the result here: https://gitlab.parity.io/parity/parity-ethereum/pipelines

also,

the parity/rust:gitlab-ci docker image (aka default) was updated with yarn installation on master branch,

.gitlab-ci was updated for debugging purposes only:

runner was changed from shell to docker (ci2)

running priority was changed to optional
all of it should be corrected before merging

TriplEight · 2019-01-04T22:08:59Z

scripts/gitlab/publish-docs.sh

-    git push origin HEAD
-    git push --tags
+    git push -q origin HEAD
+    git push -q --tags


this suppression is good enough, build log: https://gitlab.parity.io/parity/parity-ethereum/-/jobs/114661

faced another problem though: it will fail if the tag with the same name exists, could be annoying for repeated builds, but not that critical, this is stage: optional all in all.

reverting .gitlab-ci changes in the next commit.

* publish docs changes for autogen config docs * Update publish-docs.sh adding an environment variable so js knows not to download git master and just grab the local repo * Update publish-docs.sh made some changes making this unnecessary * fix env variable env variable passes to node properly now * use yarn * test pipeline, revert me * fix test pipeline, revert me * change runner tag * change runner tag 2 * change runner tag * global git config * supress upload_files output * Update .gitlab-ci.yml reverting testing changes * Replace tag if exists Very unlikely to be important/useful

* version: bump beta to v2.2.6 * Update pwasm-utils to 0.6.1 (#10134) * version: mark upgrade critical on kovan * Identity fix (#10128) * fix #10125 fix service transaction version detection if --identity is enabled, change test to match how --identity actually works * fix wrong var * get the index of v, not / * idx, not idx.len() * Update ethcore/sync/src/chain/propagator.rs Co-Authored-By: joshua-mir <[email protected]> * Update ethcore/sync/src/chain/propagator.rs Co-Authored-By: joshua-mir <[email protected]> * change version prefix to a const * space Co-Authored-By: joshua-mir <[email protected]> * [Hit return to continue] * ethcore: update hardcoded headers for foundation * ethcore: update hardcoded headers for ropsten * ethcore: update hardcoded headers for kovan * ethcore: use consistant formatting * ethcore: restore spaces after colon in chain spec * ethcore: fix bootnodes in chain specs * ethcore: fix bootnodes in chain specs * ethcore: enforce newline at the end of chainspecs * Follow-up to #10105 (#10107) * HF in POA Sokol (2019-01-04) (#10077) * HF in POA Sokol (2019-01-04) poanetwork/poa-chain-spec#91 * Update POA Core bootnodes * Autogen docs for the "Configuring Parity Ethereum" wiki page. (#10067) * publish docs changes for autogen config docs * Update publish-docs.sh adding an environment variable so js knows not to download git master and just grab the local repo * Update publish-docs.sh made some changes making this unnecessary * fix env variable env variable passes to node properly now * use yarn * test pipeline, revert me * fix test pipeline, revert me * change runner tag * change runner tag 2 * change runner tag * global git config * supress upload_files output * Update .gitlab-ci.yml reverting testing changes * Replace tag if exists Very unlikely to be important/useful * Autogen docs for the "Configuring Parity Ethereum" wiki page. (#10067) * publish docs changes for autogen config docs * Update publish-docs.sh adding an environment variable so js knows not to download git master and just grab the local repo * Update publish-docs.sh made some changes making this unnecessary * fix env variable env variable passes to node properly now * use yarn * test pipeline, revert me * fix test pipeline, revert me * change runner tag * change runner tag 2 * change runner tag * global git config * supress upload_files output * Update .gitlab-ci.yml reverting testing changes * Replace tag if exists Very unlikely to be important/useful * finality: dont require chain head to be in the chain (#10054) * Fill transaction hash on ethGetLog of light client. (#9938) * Fill transaction hash on ethGetLog of light client. This is enifficient but we keep align with spec. * Using better variables names. * Expose old fast light get log as `parity_getLogsLight`. * Update rpc/src/v1/helpers/light_fetch.rs Fix indent. Co-Authored-By: cheme <[email protected]> * Factor common code between light_logs and logs. * Remove useless check * Rename parity light logs to 'parity_getLogsNoTransactionHash'. Fix indent and extra white lines. * Use vec instead of tree map to avoid inner function. * better loop * fix pubsub new_blocks notifications to include all blocks (#9987) Fix: new blocks notifications sometimes missing in pubsub RPC Implement new struct to pass to `new_blocks()` with extra parameter - `has_more_blocks_to_import`, which was previously used to determine whether the notification should be sent. Now it's up to each implementation to decide what to do. Updated all implementations to behave as before, except `eth_pubsub`, which will send notification even when the queue is not empty. Update tests. * Revert part of 70a6db7 * HF in POA Core (2019-01-18) - Constantinople (#10155) poanetwork/poa-chain-spec#100 * ci: re-enable snap publishing (#10142) * ci: enable snap publishing~ * ci: add publish snap script * ci: add snapcraft skeleton * ci: group export statements * ci: enable snaps on pr branch * ci: enable snaps on pr branch * ci: set default BUILD_ARCH * ci: enable snaps on pr branch * ci: enable snaps on pr branch * ci: add libdb to snap * ci: reinitiate gitlabci * ci: reinitiate publish-snap script * ci: fix yaml syntax * cargo/gitlab env vars * debug, revert me * version? * debug vars * vars * vars fix * vars fix * revert * Update scripts/gitlab/publish-snap.sh Co-Authored-By: 5chdn <[email protected]> * ci: read track from cargo toml * Make sure parent block is not in importing queue when importing ancient blocks (#10138) * Make sure parent block is not in importing queue when importing ancient blocks * Clear queue when an ancient import fails * Lock only once in clear * Add comments why queued check is needed * Should push the value back to the queue * Directly check in chain.read() * Remove extra empty line * Revert unused verification change

publish docs changes for autogen config docs

4da8b29

jam10o-new added A3-inprogress ⏳ Pull request is in progress. No review needed at this stage. M1-ci 🙉 Continuous integration. M3-docs 📑 Documentation. labels Dec 14, 2018

jam10o-new added this to the 2.3 milestone Dec 14, 2018

jam10o-new mentioned this pull request Dec 14, 2018

Generate docs from code #9974

Closed

jam10o-new mentioned this pull request Dec 24, 2018

Autogen config docs paritytech/parity-config-generator#47

Merged

jam10o-new added A0-pleasereview 🤓 Pull request needs code review. and removed A3-inprogress ⏳ Pull request is in progress. No review needed at this stage. labels Dec 24, 2018

tomusdrw reviewed Dec 27, 2018

View reviewed changes

jam10o-new added 3 commits December 27, 2018 12:48

Update publish-docs.sh

343fe59

adding an environment variable so js knows not to download git master and just grab the local repo

Update publish-docs.sh

aba0a49

made some changes making this unnecessary

fix env variable

169c30a

env variable passes to node properly now

tomusdrw approved these changes Dec 27, 2018

View reviewed changes

jam10o-new and others added 3 commits December 27, 2018 23:01

use yarn

6c7d0c6

test pipeline, revert me

4bf9351

fix test pipeline, revert me

45962a5

TriplEight reviewed Jan 3, 2019

View reviewed changes

scripts/gitlab/publish-docs.sh Show resolved Hide resolved

TriplEight and others added 4 commits January 3, 2019 21:45

change runner tag

86eaccd

change runner tag 2

c7b6c06

change runner tag

f46fa37

global git config

88ca373

TriplEight and others added 2 commits January 4, 2019 22:32

supress upload_files output

b81ddde

Update .gitlab-ci.yml

bac28ba

reverting testing changes

jam10o-new changed the title ~~[WIP] Autogen docs for the "Configuring Parity Ethereum" wiki page.~~ Autogen docs for the "Configuring Parity Ethereum" wiki page. Jan 7, 2019

Replace tag if exists

2b243d8

Very unlikely to be important/useful

TriplEight approved these changes Jan 7, 2019

View reviewed changes

TriplEight merged commit 1fda997 into master Jan 7, 2019

5chdn deleted the autogen-config-docs branch January 7, 2019 13:49

5chdn added the B1-patch-beta 🕷🕷 label Jan 7, 2019

5chdn mentioned this pull request Jan 7, 2019

beta backports v2.2.6 #10113

Merged

15 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Autogen docs for the "Configuring Parity Ethereum" wiki page. #10067

Autogen docs for the "Configuring Parity Ethereum" wiki page. #10067

jam10o-new commented Dec 14, 2018

parity-cla-bot commented Dec 14, 2018

jam10o-new commented Dec 24, 2018

tomusdrw left a comment

tomusdrw Dec 27, 2018

jam10o-new Dec 27, 2018

tomusdrw Dec 27, 2018

tomusdrw left a comment

tomusdrw Dec 27, 2018

jam10o-new Dec 27, 2018

tomusdrw Dec 27, 2018

ddorgan Dec 27, 2018

jam10o-new Dec 27, 2018

jam10o-new commented Jan 4, 2019 •

edited

Loading

TriplEight Jan 3, 2019

TriplEight Jan 3, 2019

TriplEight Jan 3, 2019

TriplEight Jan 4, 2019

Autogen docs for the "Configuring Parity Ethereum" wiki page. #10067

Autogen docs for the "Configuring Parity Ethereum" wiki page. #10067

Conversation

jam10o-new commented Dec 14, 2018

parity-cla-bot commented Dec 14, 2018

jam10o-new commented Dec 24, 2018

tomusdrw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomusdrw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jam10o-new commented Jan 4, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jam10o-new commented Jan 4, 2019 •

edited

Loading