-
Notifications
You must be signed in to change notification settings - Fork 119
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
fixes 1611: adds page for boilerplate config and clarifies profiles #1644
fixes 1611: adds page for boilerplate config and clarifies profiles #1644
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
@non-fungible-nelson The profile page should now make clearer the role of profiles. The new config defaults page is ready to build out according to those defaults you wish to highlight -- PTAL docs/public-networks/how-to/use-configuration-file/defaults.md |
I think the only thing missing is the Sync modes from Default for "Snap" sync. This should be included as well. Otherwise, LGTM 🚢 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note for the next reviewer:
This is another page to check: https://besu-docs-git-fork-m4sterbunny-1611-profile-623a56-hyperledger.vercel.app/development/public-networks/how-to/use-configuration-file/defaults
Signed-off-by: m4sterbunny <[email protected]>
Signed-off-by: m4sterbunny <[email protected]>
Signed-off-by: m4sterbunny <[email protected]>
Add sync and storage Signed-off-by: Joan E <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
Signed-off-by: Joan E <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
Signed-off-by: Joan E <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
* adding in some details re the peering process Signed-off-by: Joshua Fernandes <[email protected]> * edit p2p discovery process and tutorials Signed-off-by: Alexandra Tran <[email protected]> * Update docs/public-networks/how-to/connect/manage-peers.md Signed-off-by: Alexandra Carrillo <[email protected]> --------- Signed-off-by: Joshua Fernandes <[email protected]> Signed-off-by: Alexandra Tran <[email protected]> Signed-off-by: Alexandra Carrillo <[email protected]> Co-authored-by: Alexandra Tran <[email protected]> Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
Signed-off-by: Joan E <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Simon Dudley <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
Signed-off-by: m4sterbunny <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestions for style/simplicity.
proof Co-authored-by: Joan E <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
reframing Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]>
Signed-off-by: m4sterbunny <[email protected]>
f08f976
to
f1cf95a
Compare
Thank you all for the effort getting this across the line! |
…1644) * fixes 1611: adds page for boilerplate config and clarifies profiles Signed-off-by: m4sterbunny <[email protected]> * proofs 1611 Signed-off-by: m4sterbunny <[email protected]> * proofs 1611: instruction to caps vars Signed-off-by: m4sterbunny <[email protected]> * Update sync and storage Add sync and storage Signed-off-by: Joan E <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * update to include storage Signed-off-by: Joan E <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * add links Signed-off-by: Joan E <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * adding in some details re the peering process (#1643) * adding in some details re the peering process Signed-off-by: Joshua Fernandes <[email protected]> * edit p2p discovery process and tutorials Signed-off-by: Alexandra Tran <[email protected]> * Update docs/public-networks/how-to/connect/manage-peers.md Signed-off-by: Alexandra Carrillo <[email protected]> --------- Signed-off-by: Joshua Fernandes <[email protected]> Signed-off-by: Alexandra Tran <[email protected]> Signed-off-by: Alexandra Carrillo <[email protected]> Co-authored-by: Alexandra Tran <[email protected]> Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * remove note Signed-off-by: Joan E <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/use-configuration-file/defaults.md proof Co-authored-by: Simon Dudley <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * improves GH links Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/use-configuration-file/defaults.md proof Co-authored-by: Simon Dudley <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * 6612: Remove remaining references to X_SNAP and X_CHECKPOINT from unv… (#1651) * 6612: Remove remaining references to X_SNAP and X_CHECKPOINT from unversioned docs Signed-off-by: Matilda Clerke <[email protected]> * Update docs/public-networks/how-to/bonsai-limit-trie-logs.md Co-authored-by: Sally MacFarlane <[email protected]> Signed-off-by: Joan E <[email protected]> --------- Signed-off-by: Matilda Clerke <[email protected]> Signed-off-by: Joan E <[email protected]> Co-authored-by: Joan E <[email protected]> Co-authored-by: Sally MacFarlane <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Add Lukso to command line table (#1647) * Add Lukso to command line table Signed-off-by: Joan E <[email protected]> * Add links to table to help users access aux docs Signed-off-by: Joan E <[email protected]> --------- Signed-off-by: Joan E <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Version update automation (#1654) Deleted the workflow added incorrectly to the .github folder. Added new workflow file to perform the version update steps when a new release is created Signed-off-by: Chaminda Divitotawela <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Allow version update with workflow dispatch (#1655) * Allow version update with workflow dispatch Was looking to trigger the version update workflow by re-creating the release 24.7.0. However when a release it re-created from the same commit which has been created a release, it does not seems to trigger the even type released. Added workflow_dispatch also to the same workflow so that users can manually trigger the version update if necessary. Signed-off-by: Chaminda Divitotawela <[email protected]> * Actionlint fixes Signed-off-by: Chaminda Divitotawela <[email protected]> --------- Signed-off-by: Chaminda Divitotawela <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update version 24.7.0 (#1657) Signed-off-by: Besu Bot <[email protected]> Co-authored-by: Besu Bot <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update table to include SNAP (#1658) * Update table to include SNAP Signed-off-by: Joan E <[email protected]> * Update docs/public-networks/reference/cli/options.md Co-authored-by: Sally MacFarlane <[email protected]> Signed-off-by: Joan E <[email protected]> --------- Signed-off-by: Joan E <[email protected]> Co-authored-by: Sally MacFarlane <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * adds default sync Signed-off-by: m4sterbunny <[email protected]> * fixes: copy/pasta Signed-off-by: m4sterbunny <[email protected]> * adds defaults to sidebar Signed-off-by: m4sterbunny <[email protected]> * update relative link Signed-off-by: Joan E <[email protected]> * renames index to accomodate defaults also and updates links/adds redirects Signed-off-by: m4sterbunny <[email protected]> * renames index to accomodate defaults also and updates links/adds redirects Signed-off-by: m4sterbunny <[email protected]> * responds to link issues https://github.com/hyperledger/besu-docs/actions/runs/10095001531/job/27914102000\?pr\=1644 Signed-off-by: m4sterbunny <[email protected]> * responds to link issues https://github.com/hyperledger/besu-docs/actions/runs/10095001531/job/27914102000\?pr\=1644 Signed-off-by: m4sterbunny <[email protected]> * responds to link issues https://github.com/hyperledger/besu-docs/actions/runs/10095001531/job/27914102000\?pr\=1644 Signed-off-by: m4sterbunny <[email protected]> * responds to link issues https://github.com/hyperledger/besu-docs/actions/runs/10095001531/job/27914102000\?pr\=1644 Signed-off-by: m4sterbunny <[email protected]> * responds to link issues https://github.com/hyperledger/besu-docs/actions/runs/10095001531/job/27914102000\?pr\=1644 Signed-off-by: m4sterbunny <[email protected]> * temp fix for redirect Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/index.md proof Co-authored-by: Simon Dudley <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update profile.md adds tags to new page Signed-off-by: m4sterbunny <[email protected]> * check link Signed-off-by: Joan E <[email protected]> * add back link Signed-off-by: Joan E <[email protected]> * Update docs/public-networks/how-to/configure-besu/index.md proof Co-authored-by: Joan E <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/index.md proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/index.md reframing Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/index.md proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/index.md proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/index.md proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/profile.md proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/profile.md proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/profile.md proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/profile.md proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/profile.md proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/index.md proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/index.md proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * Update docs/public-networks/how-to/configure-besu/index.md proof Co-authored-by: Alexandra Carrillo <[email protected]> Signed-off-by: m4sterbunny <[email protected]> * aligns index with additional function custom profiles Signed-off-by: m4sterbunny <[email protected]> --------- Signed-off-by: m4sterbunny <[email protected]> Signed-off-by: Joan E <[email protected]> Signed-off-by: Joshua Fernandes <[email protected]> Signed-off-by: Alexandra Tran <[email protected]> Signed-off-by: Alexandra Carrillo <[email protected]> Signed-off-by: Matilda Clerke <[email protected]> Signed-off-by: Chaminda Divitotawela <[email protected]> Signed-off-by: Besu Bot <[email protected]> Co-authored-by: Joan E <[email protected]> Co-authored-by: Joshua Fernandes <[email protected]> Co-authored-by: Alexandra Tran <[email protected]> Co-authored-by: Alexandra Carrillo <[email protected]> Co-authored-by: Simon Dudley <[email protected]> Co-authored-by: Matilda-Clerke <[email protected]> Co-authored-by: Sally MacFarlane <[email protected]> Co-authored-by: Chaminda Divitotawela <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Besu Bot <[email protected]> Signed-off-by: Joan E <[email protected]>
Description
Simplifies profile explainer page and instructs how to load custom profile
Changes page to be "Configure Besu" to acommodate config file instructions AND default config
Edits links for page name change and updates redirects for the same
Small proofs to the CLI page
Responds to (unrelated) broken link issues as per linting >> https://github.com/hyperledger/besu-docs/actions/runs/10095001531/job/27914102000\?pr\=1644
Issue(s) fixed
Fixes #1611
Preview
Main pages impacted: