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.

Sign up for GitHub

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

Jump to bottom

Update Container README files #44

Open
CSpicer-BAH opened this issue May 5, 2022 · 0 comments
Open

Update Container README files #44

CSpicer-BAH opened this issue May 5, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@CSpicer-BAH
Copy link
Contributor

Issue

Some container projects don't provide useful information for users in their README files, such as environment variables needed. This has led to confusion for users on how a container is intended to function or to be deployed, among others.

Definition of Done

Containers have been reviewed and have updated their README files where appropriate.

Acceptance Criteria

  • A standard template has been applied to container READMEs
  • Notes for deploying and testing locally have been documented
  • Special container requirements have been documented
@CSpicer-BAH CSpicer-BAH added the documentation Improvements or additions to documentation label May 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@CSpicer-BAH