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

• local development (configure.md, deploy.md)
• production (configure.md, deploy.md)
• administrative user creation (first-run.md)
• 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

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

Operator docs

• canonical experiment number howto
• experiment workflow progression

Administrator docs

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