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

[Docs] Streamline default poktrolld configurations #1011

Open
7 tasks
Olshansk opened this issue Dec 16, 2024 · 2 comments
Open
7 tasks

[Docs] Streamline default poktrolld configurations #1011

Olshansk opened this issue Dec 16, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation tooling Tooling - CLI, scripts, helpers, off-chain, etc...

Comments

@Olshansk
Copy link
Member

Olshansk commented Dec 16, 2024

Objective

Make usage of poktrolld simpler by setting default configs (home directory, RPC node, etc...).

Origin Document

This was created as a result of multiple conversations from #947.

To limit the scope of #947 to the supplier cheatsheet, this ticket was created.

Screenshot 2024-12-16 at 11 05 12 AM

Goals

  • Streamline the usage of poktrolld
  • Ensure documents are consistent across the board (walkthroughs, cheatsheest, etc...)

Deliverables

  • Update the documentation to leverage poktrolld config set client node
  • Update the documentation to leverage poktrolld config home
  • Ensure the old (POCKET_NODE env variable) & new approaches (configs above) are complimentary and clearly explained to the user
  • Make the walkthroughs explain both but have the cheat sheets just leverage one
  • Make sure that all walkthroughs and all cheat sheets are consistent
  • Cross reference documentation with poktroll-docker-compose-example
  • Remove the presence of $NODE_FLAGS when/where appropriate

Non-goals / Non-deliverables

  • Force everyone to use poktrolld config for all operations
  • Document poktrolld in detail
  • [OPTIONAL] Create a new page called poktrolld config

Creator: @Olshansk
Co-Owners: @bryanchriswhite

@Olshansk Olshansk added documentation Improvements or additions to documentation tooling Tooling - CLI, scripts, helpers, off-chain, etc... labels Dec 16, 2024
@Olshansk Olshansk added this to Shannon Dec 16, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Shannon Dec 16, 2024
@Olshansk Olshansk moved this from 📋 Backlog to 👀 In review in Shannon Dec 16, 2024
@Olshansk Olshansk added this to the Shannon Beta TestNet Support milestone Dec 16, 2024
@Olshansk Olshansk moved this from 👀 In review to 📋 Backlog in Shannon Dec 16, 2024
@okdas
Copy link
Member

okdas commented Dec 17, 2024

This is good! Thanks.

New (I assume 0.52) cosmos-sdk will have clientconfig.DefaultClientConfigTemplate which will allow us to create a custom client config. I started working on this in #940 only to realize that functionality is not available on cosmos-sdk version we're using.

@Olshansk
Copy link
Member Author

Noted @okdas. Moving this to the next iteration.

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 tooling Tooling - CLI, scripts, helpers, off-chain, etc...
Projects
Status: 📋 Backlog
Development

No branches or pull requests

3 participants