Skip to content

Complete documentation coverage of registry operator #1015

Closed
devfile/registry-operator
#46
@michael-valdron

Description

@michael-valdron

/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

Metadata

Metadata

Assignees

Labels

area/registryDevfile registry for stacks and infrastructurekind/user-storyUser story for new enhancement

Type

No type

Projects

Status

Done ✅

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions