documentation.git
documentation contributor guide (this is a work in progress!)
Docs Structure
Types of Documentation
Documentation is maintained in two separate ways: 1) the traditional wiki maintained outside of CI/CD; and 2) Automated Developer Notes using CI/CD
Wiki | Automated Website |
---|---|
wiki.acumos.org | |
Space for contributors to plan
Discussion Forums on the Questions forum | Automatic generation of Developer Guides and Readme website
|
Automated
WebsiteDocumentation using RST and Sphinx Tool
Documentation Users | Tools to Maintain Documentation |
---|---|
Platform Administrators
| RST format files
|
Administrator
| Sphinx tool
|
Acumos User or Tester
| Jenkins job
|