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

Should a block producer topology be included as an example? #1316

Open
stevanlohja opened this issue Sep 5, 2024 · 2 comments
Open

Should a block producer topology be included as an example? #1316

stevanlohja opened this issue Sep 5, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@stevanlohja
Copy link

I noticed that there's a relay node topology file example here https://developers.cardano.org/docs/operate-a-stake-pool/cardano-relay-configuration

However, in the following block produce config there's no topology example. It might be nice to describe an example of a block producer node topology file (unless there is one and I've missed it)

@rphair rphair added the documentation Improvements or additions to documentation label Sep 5, 2024
@rphair
Copy link
Collaborator

rphair commented Sep 5, 2024

@stevanlohja I agree this would be helpful for readers that don't see... or are reluctant to assume... that the BP topology is simply a reduction of the relay topology (i.e. same general syntax but certain sections eliminated). Probably that reduced nature of the BP topology is why a specific example wasn't included for it.

@katomm @sanskys I guess the best place for this would be a file in docs/operate-a-stake-pool (cardano-bp-configuration.md) at the head of the Cardano Block Producer Configuration section, with an example topology & likely an explanation how to use the slightly different -bp default config settings that are distributed with 9.x versions of the node & CLI (cc @CarlosLopezDeLara).

@CarlosLopezDeLara CarlosLopezDeLara self-assigned this Sep 5, 2024
@sanskys
Copy link
Contributor

sanskys commented Sep 10, 2024

yes, that would be the right place. Since the documentation is more than an year old now, we can collect all suggestions and I can support in updating it.

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

No branches or pull requests

4 participants