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

Document plugins CLI option. #1790

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

Conversation

bgravenorst
Copy link
Contributor

@bgravenorst bgravenorst commented Mar 27, 2025

Description

  • Document the --plugins CLI option.
  • Move the existing plugin documentation to the "public" content.
  • Add redirects after moving content.

Issue(s) fixed

Fixes #1789

Preview

https://besu-docs-git-fork-bgravenorst-doc-1789-hyperledger.vercel.app/public-networks/reference/cli/options#plugins

Signed-off-by: bgravenorst <[email protected]>
@bgravenorst bgravenorst requested a review from a team as a code owner March 27, 2025 00:03
Copy link

vercel bot commented Mar 27, 2025

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 Mar 30, 2025 9:53pm

Signed-off-by: bgravenorst <[email protected]>
Copy link
Contributor

@Gabriel-Trintinalia Gabriel-Trintinalia left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@alexandratran alexandratran left a comment

Choose a reason for hiding this comment

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

LGTM once minor comments are addressed

<TabItem value="Syntax">

```bash
--plugins=<PLUGIN>[,<PLUGIN>...]...
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
--plugins=<PLUGIN>[,<PLUGIN>...]...
--plugins=<PLUGIN>[,<PLUGIN>,...]

</TabItem>
</Tabs>

Comma-seperated list of [plugin](../../concepts/plugins.md) names to load. Each plugin must reside in
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Comma-seperated list of [plugin](../../concepts/plugins.md) names to load. Each plugin must reside in
Comma-separated list of [plugin](../../concepts/plugins.md) names to load. Each plugin must reside in

- private networks
---

# Plugin API interfaces

API interfaces in Besu allow users to [build plugins](../concepts/plugins.md) to extend Besu functionality.
API interfaces in Besu allow users to [build plugins](../../public-networks/concepts/plugins.md) to extend Besu functionality.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
API interfaces in Besu allow users to [build plugins](../../public-networks/concepts/plugins.md) to extend Besu functionality.
API interfaces in Besu allow users to [build plugins](../concepts/plugins.md) to extend Besu's functionality.

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

Successfully merging this pull request may close these issues.

Document enhanced control over plugins registration
3 participants