Skip to content

Improve documentation for onboarding users #341

@jonesho

Description

@jonesho

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions