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.

Sign up for GitHub

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

Jump to bottom

1611(docs): improves clarity for profile #1631

Closed
wants to merge 28 commits into from
Closed

1611(docs): improves clarity for profile #1631

wants to merge 28 commits into from

Conversation

m4sterbunny
Copy link
Contributor

@m4sterbunny m4sterbunny commented Jun 24, 2024 •
edited
Loading

Responds to issue

Qs answered:

  1. No, it's not possible to create your own custom profile
  2. Yes -- by putting profile together with a boilerplate config.toml, you should get sane/staking optimized config

@m4sterbunny m4sterbunny requested a review from a team as a code owner June 24, 2024 08:43
@vercel Vercel
Copy link

vercel bot commented Jun 24, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
besu-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 2, 2024 0:54am

@m4sterbunny m4sterbunny mentioned this pull request Jun 24, 2024
Closed
@non-fungible-nelson
Copy link
Contributor

Frankly, some of these profiles were developed before we switched our Default "defaults." For example, staker had different options configured that we then made the default.

Let's discuss this in our next chat.

m4sterbunny and others added 18 commits July 1, 2024 15:20
@m4sterbunny
:1611(docs): improves clarity for profile
a329e27 
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny
:1611(docs): reverts commenting out tab
3e426e5 
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@siladu @joaniefromtheblock @m4sterbunny
Add bonsai-limit-trie-logs options and update how to page (#1627)
2ba1817 
* Add cli options for bonsai-limit-trie-logs-enabled and bonsai-trie-logs-pruning-window-size

Signed-off-by: Simon Dudley <simon.dudley@consensys.net>

* Update how to page
Signed-off-by: Simon Dudley <simon.dudley@consensys.net>

* Update docs/public-networks/how-to/bonsai-limit-trie-logs.md

Co-authored-by: Joan E <153745173+joaniefromtheblock@users.noreply.github.com>
Signed-off-by: Simon Dudley <simon.dudley@consensys.net>

* Use note as prerequisite
Signed-off-by: Simon Dudley <simon.dudley@consensys.net>

* Adding pruning prerequisite
Signed-off-by: Simon Dudley <simon.dudley@consensys.net>

* typo
Signed-off-by: Simon Dudley <simon.dudley@consensys.net>

* edit and add to versioned docs

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

* edits

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

---------

Signed-off-by: Simon Dudley <simon.dudley@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Co-authored-by: Joan E <153745173+joaniefromtheblock@users.noreply.github.com>
Co-authored-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@joaniefromtheblock @m4sterbunny
update PR template
2a76c03 
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@bgravenorst @m4sterbunny
Update minimum Java version. (#1633)
bccb784 
* Update minimum Java version.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

* Missed a few instances.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

---------

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny @non-fungible-nelson
@alexandratran @macfarla
1576(docs): documents config option (#1632)
b6801b3 
* :1576(docs): documents config option

Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

* Update docs/public-networks/reference/cli/options.md

edit

Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

* Update docs/public-networks/reference/cli/options.md

edit

Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

* Update docs/public-networks/reference/cli/options.md

proof

Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

* Update docs/public-networks/reference/cli/options.md

proof

Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

* Update docs/public-networks/reference/cli/options.md

proof

Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

* Update docs/public-networks/reference/cli/options.md

proof

Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

* Update docs/public-networks/reference/cli/options.md

proof

Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

* Update options.md

Implements feedback

Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

* Update options.md

alphabetical relocate

Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

---------

Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
Co-authored-by: Matt Nelson <85905982+non-fungible-nelson@users.noreply.github.com>
Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny
fixes 1615:temp redirect to perm (#1635)
e1c2415 
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny
fixes:1620 deprecates old image improves new (#1636)
dfbc06b 
* fixes:1620 deprecates old image improves new

Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

* Add files via upload

Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

---------

Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@cdivitotawela @m4sterbunny
Automate the Besu version update (#1638)
17fe8d8 
New workflow file update.yml automates the process outlined in https://wiki.hyperledger.org/display/BESU/Documentation+release+process. Added a comment token to the file to identify the location of the version configuration

Signed-off-by: Chaminda Divitotawela <cdivitotawela@gmail.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny @joaniefromtheblock
1577: adds price bump config (#1639)
816a633 
* 1577: adds price bump config

Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

* 1577: QA

Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

* Update docs/public-networks/reference/cli/options.md

as per review

Co-authored-by: Joan E <153745173+joaniefromtheblock@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>

---------

Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
Co-authored-by: Joan E <153745173+joaniefromtheblock@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@siladu @joaniefromtheblock @m4sterbunny
Promote x-trie-log subcommand to trie-log (#1640)
b49a2eb 
* Promote x-trie-log subcommand to trie-log
Signed-off-by: Simon Dudley <simon.dudley@consensys.net>

* small edit

---------

Co-authored-by: Joan E <153745173+joaniefromtheblock@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@joaniefromtheblock @m4sterbunny
Remove space from metadata
b7e4cae 
Signed-off-by: Joan E <153745173+joaniefromtheblock@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@joaniefromtheblock @m4sterbunny
Copy edits for consistency (#1641)
ed341e8 
Signed-off-by: Joan E <153745173+joaniefromtheblock@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny
resets profile page following discussion
5ec81c6 
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny
as per discussion: provides page to discuss boilerplate configs
95e392c 
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny
advances boilerplate configs
d87f2be 
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny
triggering commit to sign
195102a 
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny
Merge branch 'main' into 1611-clarify-profile
4f0a259
@m4sterbunny m4sterbunny marked this pull request as draft July 1, 2024 20:41
joaniefromtheblock
joaniefromtheblock reviewed Jul 2, 2024
View reviewed changes
docs/public-networks/reference/cli/options.md
@@ -2584,7 +2583,7 @@ UPnP support is often disabled by default in networking firmware. If disabled by

:::tip

Use `UPNPP2PONLY` if you wish to enable UPnP for p2p traffic but not JSON-RPC.
Use `UPNPP2PONLY` if you wish to enable UPnP for P2P traffic but not JSON-RPC.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would take "wish" out

https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/w/want

Maybe something like:

Suggested change
Use `UPNPP2PONLY` if you wish to enable UPnP for P2P traffic but not JSON-RPC.
Use `UPNPP2PONLY` to enable UPnP for P2P traffic but not JSON-RPC.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Er -- don't want to stray too far from issue >> this will need its own issue. My OC just couldn't help itself and corrected p2p

@joaniefromtheblock
Copy link
Contributor

joaniefromtheblock commented Jul 2, 2024 •
edited
Loading

Hey @m4sterbunny. You probably are not able to view the checks/ error messages:

image

It's throwing an error because it doesn't recognize two words: "tollerated" and "simplifes". If you correct these, all checks should pass :]

m4sterbunny and others added 2 commits July 2, 2024 13:00
@m4sterbunny @joaniefromtheblock
Update docs/public-networks/how-to/use-configuration-file/profile.md
bf7c61b 
Co-authored-by: Joan E <153745173+joaniefromtheblock@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny
reworks following proof round
112ea80
m4sterbunny and others added 2 commits July 2, 2024 13:15
@m4sterbunny @joaniefromtheblock
Update docs/public-networks/how-to/use-configuration-file/defaults.md
913f2e6 
Co-authored-by: Joan E <153745173+joaniefromtheblock@users.noreply.github.com>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny
reworks following proof round
c6c48c4
@m4sterbunny
reworks following proof round
f3371bc 
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny
reworks following proof round
8e834c8 
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny
signing
7902925 
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
@m4sterbunny m4sterbunny closed this by deleting the head repository Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joaniefromtheblock joaniefromtheblock joaniefromtheblock left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@m4sterbunny @non-fungible-nelson @joaniefromtheblock @siladu @bgravenorst @cdivitotawela