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

Improve documentation for onboarding users #341

Open
6 tasks
jonesho opened this issue Nov 27, 2024 · 1 comment
Open
6 tasks

Improve documentation for onboarding users #341

jonesho opened this issue Nov 27, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@jonesho
Copy link
Contributor

jonesho commented Nov 27, 2024

Description

We need to improve our documentation in the repo (under the docs folder) regarding onboarding new users, for instance, how to locally build the docker image of various services such as coordinator. The goal is to provide sufficient information for users to run, develop, and test on local stack with ease.

We already have a ticket opened by an external contributor because the lack of documentation on how to build coordinator image locally.

Motivation

This section should indicate what value we are receiving from it.

Tasks

  • Medium-level task that needs to be implemented for this feature request to be considered complete.

Acceptance criteria

  • List tests that need to be implemented or checks to consider this task completed.

Risks

  • These are risks that may prevent completion of the task as well as areas to pay special attention to

Remember to

  • Add the documentation label in case there is an impact on the documentation
  • Add priority and team labels
  • Add Task for updating the Runbook or adding/updating existing metrics and alerts.
@jonesho jonesho added the documentation Improvements or additions to documentation label Nov 27, 2024
@julien-marchand julien-marchand assigned jonesho and jlwllmr and unassigned jonesho and jlwllmr Nov 27, 2024
@julien-marchand julien-marchand added the good first issue Good for newcomers label Nov 27, 2024
@jlwllmr
Copy link

jlwllmr commented Nov 27, 2024

@bgravenorst put together this PR for the docs repo a while ago: Consensys/doc.linea#624

It could be checked to make sure it's still relevant, and added somewhere in the docs. Or it could be repurposed and placed somewhere in the monorepo. Let me know if you want any help with this.

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants