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

Add instructions for enabling linea-sequencer plugin #680

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

jlwllmr
Copy link
Collaborator

@jlwllmr jlwllmr commented Aug 12, 2024

The plugin is required for node runners that are interacting with the blockchain using Besu. Added a callout to the main binary dist instructions that links out to an instruction page.

Separated the instructions off from the main node running instructions in order to keep the latter tidy and clear.

Copy link

vercel bot commented Aug 12, 2024

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

Name Status Preview Comments Updated (UTC)
doc-zk-evm ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 15, 2024 8:17am

@bgravenorst
Copy link
Collaborator

bgravenorst commented Aug 14, 2024

I believe this page will also need to be updated. Also, it doesn't look like the new page has been added to the sidebar.

Copy link
Collaborator

@bgravenorst bgravenorst left a comment

Choose a reason for hiding this comment

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

Added some feedback

docs/developers/guides/run-a-node/linea-sequencer.mdx Outdated Show resolved Hide resolved
docs/developers/guides/run-a-node/linea-sequencer.mdx Outdated Show resolved Hide resolved
docs/developers/guides/run-a-node/linea-sequencer.mdx Outdated Show resolved Hide resolved
docs/developers/guides/run-a-node/linea-sequencer.mdx Outdated Show resolved Hide resolved
1. Go to the [`linea-sequencer` repo releases page](https://github.com/Consensys/linea-sequencer/releases)
and download the `.jar` file for the latest release.

2. In the local Besu runtime directory (where you will run Besu from), create a directory called
Copy link
Collaborator

Choose a reason for hiding this comment

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

"In the root of the Besu installation directory"?

Copy link
Collaborator Author

@jlwllmr jlwllmr Aug 14, 2024

Choose a reason for hiding this comment

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

the original instructions (https://github.com/Consensys/linea-sequencer/blob/main/docs/quickstart.md) stated explicitly the runtime directory, "not where you're building Besu", so I tried to reflect this -- unsure if I did so correctly. I.e. unsure if the installation directory == runtime directory?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Cool, the Besu docs is also slightly inconsistent as to where the plugin goes: https://besu.hyperledger.org/development/private-networks/concepts/plugins#install-plugins

So I'm a bit confused. I'm sure users will be too.

docs/developers/guides/run-a-node/linea-sequencer.mdx Outdated Show resolved Hide resolved
docs/developers/guides/run-a-node/use-binary.mdx Outdated Show resolved Hide resolved
docs/developers/guides/run-a-node/use-binary.mdx Outdated Show resolved Hide resolved
docs/developers/guides/run-a-node/use-binary.mdx Outdated Show resolved Hide resolved
@jlwllmr
Copy link
Collaborator Author

jlwllmr commented Aug 14, 2024

thank you @bgravenorst -- updated the index page as you suggested. I also intentionally didn't add the linea-sequencer instructions to the sidebar to avoid clutter (similar to the enodes page).

@bgravenorst
Copy link
Collaborator

thank you @bgravenorst -- updated the index page as you suggested. I also intentionally didn't add the linea-sequencer instructions to the sidebar to avoid clutter (similar to the enodes page).

I think this content is important (especially for node providers) so perhaps requires a place on the sidebar to improve the ability to find the content. However, I agree with you that it does clutter up the content. The initial plan (in the information architecture we reviewed) was to eventually move the Run a Node content into it's own section, so perhaps that's something I can work on next. In doing so I'll properly organise the content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants