This has been a large scale project for a while but has not been documented in public
Even pre-fork the documentation has been a bit of a mess of duplicate pages and confusing information.
The fork itself cleaned up a lot of unnecessary information about no-longer-supported methods of installing CollectOSS, but theres still a lot of work to do.
My Ideal Future Docs Layout:
- Welcome (maybe have this be the index page
- About CollectOSS
- Our Mission/scope (what is it and what would it take to expand it)
- FAQ
- Quickstart
- Getting Started (more in depth tutorials)
- Deployment Guide
- Development Guide
- Configuring CollectOSS (Environment Variables, config files, etc)
- Database
- Schema (make sure its being updated automatically)
- Unused tables in Augur
- Explanations of Technologies
- REST API Documentation (make sure its being automatically updated)
- CollectOSS Standard Operating Procedures
- Release Process
- Merge Process
- Triage/Labeling
This has been a large scale project for a while but has not been documented in public
Even pre-fork the documentation has been a bit of a mess of duplicate pages and confusing information.
The fork itself cleaned up a lot of unnecessary information about no-longer-supported methods of installing CollectOSS, but theres still a lot of work to do.
My Ideal Future Docs Layout:
Docker