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

Complete documentation coverage of registry operator #1015

Closed
2 tasks done
Tracked by #410
michael-valdron opened this issue Jan 26, 2023 · 0 comments · Fixed by devfile/registry-operator#46
Closed
2 tasks done
Tracked by #410

Complete documentation coverage of registry operator #1015

michael-valdron opened this issue Jan 26, 2023 · 0 comments · Fixed by devfile/registry-operator#46
Assignees
Labels
area/registry Devfile registry for stacks and infrastructure kind/user-story User story for new enhancement

Comments

@michael-valdron
Copy link
Member

michael-valdron commented Jan 26, 2023

/kind user-story

Which area this user story is related to?

/area registry

User Story

For someone who uses the registry operator to manager their deployment of the devfile registry, it is important to know what options can be set and how to set them.

The README.md and other supporting documentation files for the registry operator should have complete coverage on usage of its makefile and deployment spec fields. These should describe what the usage is and what it does.

When using helm chart for devfile registry deployments, the individual performing this has access to complete documentation on how to use and specify parameters for the deployment. This provides someone deploying the devfile registry with the ease to take full advantage of what they need for their deployment environment.

Acceptance Criteria

  • Provide complete documentation on makefile usage
  • Provide complete documentation on deployment spec fields
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/registry Devfile registry for stacks and infrastructure kind/user-story User story for new enhancement
Projects
Status: Done ✅
Development

Successfully merging a pull request may close this issue.

2 participants