Documentation Audit and reorg
- Dominant language
- Python
- Stars
- 13
- Forks
- 17
- Avg merge
- 6h 59m
- Merged PRs (30d)
- 1
Description
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.
- [ ] many places in the docs are labeled with "under construction" banners
- [ ] ["what is collectoss"](https://collectoss.readthedocs.io/en/latest/index.html#what-is-collectoss) needs to move from the top level TOC into its own page under the "about" section
- [ ] ["explainations of technologies"](https://collectoss.readthedocs.io/en/latest/quick-start.html#explanations-of-technologies) should be removed from the quickstart (it exists [here](https://collectoss.readthedocs.io/en/latest/development-guide/tech-breakdown.html) already)
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
* ~~Docker~~
* Getting Started (more in depth tutorials)
* Deployment Guide
* Production Deployment
* 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
Contributor guide
Assessment
This issue has not been assessed yet.