Documentation - developer / operator / user

[mjstealey]

Documentation

Documentation for deployment, users, developers, operators and administrators

Deployment docs

Documentation to reside as markdown files in the docs directory of the repository

• [x] local development (configure.md, deploy.md)
• [x] production (configure.md, deploy.md)
• [x] administrative user creation (first-run.md)
• [x] database backup and recovery (db-backup-restore.md)

User docs

• maintained outside of this repository by the AERPAW team

Developer docs - with example code

Documentation to reside within the examples directory of the repository

• [x] canonical-experiment-resource
• [x] credentials
• [x] experiment-files
• [ ] experiments
• [x] messages
• [x] p-canonical-experiment-number
• [x] projects
• [x] requests
• [x] resources
• [x] sessions
• [x] token/refresh/
• [x] user-experiment
• [x] user-project
• [x] users

Operator docs

• [ ] canonical experiment number howto
• [ ] experiment workflow progression

Administrator docs

• [ ] managing user role requests
• [ ] managing users from the Django admin panel