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

Documentation #21

Open
6 tasks
brynolv opened this issue Dec 3, 2020 · 0 comments
Open
6 tasks

Documentation #21

brynolv opened this issue Dec 3, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation
Projects
The Documentation Project

Comments

@brynolv
Copy link

brynolv commented Dec 3, 2020 •
edited by mattiasgrenfeldt

Documentation Guidelines

A Repository is considered documented if it meets the following requirement:

  • it has an API specification for all its endpoints
  • it has a segment specifying ENV variables required
  • it has a complete list of dependencies specifying which other systems it uses/relies on
  • it has a complete set of instructions for how to launch the system in a production environment
  • it has a complete set of instructions for how to launch the system in a development environment
  • it has a description of all Pls permissions it uses and how they affect the application
@brynolv brynolv added the documentation Improvements or additions to documentation label Dec 3, 2020
@brynolv brynolv added this to To do in The Documentation Project via automation Dec 3, 2020
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
The Documentation Project
To do
Milestone
No milestone
Development

No branches or pull requests
1 participant
@brynolv