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

[Documentation] Different ways to install poktrolld #525

Closed
1 of 6 tasks
okdas opened this issue May 10, 2024 · 1 comment
Closed
1 of 6 tasks

[Documentation] Different ways to install poktrolld #525

okdas opened this issue May 10, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation tooling Tooling - CLI, scripts, helpers, off-chain, etc...

Comments

@okdas
Copy link
Member

okdas commented May 10, 2024

Objective

Document and showcase how poktrolld can be installed using different methods.

Origin Document

Currently, we have documentation on how to install using development set up and how to use development images, but we need a dedicated documentation for installation. Now that we have production-grade images and binaries, we can do that.

Deliverables

  • Document binaries and production images
  • Document install from source (make install)

Non-goals / Non-deliverables

  • Do not cover all the deployment options - there will be a separate ticket for it.

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit and/or E2E) to the test suite.
  • Makefile: Add new targets to the Makefile to make the new functionality easier to use.
  • Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: @okdas

@okdas okdas self-assigned this May 10, 2024
@okdas okdas added documentation Improvements or additions to documentation tooling Tooling - CLI, scripts, helpers, off-chain, etc... labels May 10, 2024
@okdas okdas added this to the Shannon Public TestNet milestone May 10, 2024
@okdas
Copy link
Member Author

okdas commented May 10, 2024

cc @Olshansk

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: ✅ Done
Development

No branches or pull requests

1 participant