25ec0cdeaf
Create a Project section and move several previously miscategorised reference pages to it. Move the remaining previously miscategorised reference pages to the software-contributions directory under the Community section. Remove Reference section because there is no pertinent content to put there. In the future, text leveraging the Charmhub to cite software reference content will be added. This mostly relates to charm actions and configuration options. The metadata.yaml file may need to be manually explained due to this data being missing from the Charmhub. Add hierarchy to the Community section in terms of software contributions and documentation contributions. Rename a few pages (give them better names). Adjust internal links accordingly. Add redirects accordingly for older/established pages. Change-Id: I6b375bd22a62c62fd64a6a83ee0c2d2141e44e23
1.7 KiB
1.7 KiB
Documentation contributions
Documentation for the OpenStack Charms project uses the Docs as Code model where the source text is maintained under a version control system, Git in this case.
Contributions can take the form of improvements to existing pages or the addition of new content. The following resources are available:
adding-new-content doc-style-guide
Below is a summary of all documentation sources for the OpenStack Charms project.
| Published | Domain | Platform | Format | Diátaxis |
|---|---|---|---|---|
| OpenStack Charm Guide | docs.openstack.org | OpenDev | Sphinx RST | Tutorials, Howtos, Concepts, Reference |
| OpenStack Charms Deployment Guide | docs.openstack.org | OpenDev | Sphinx RST | Howtos |
| OpenStack Charms Admin Guide | docs.openstack.org | OpenDev | Sphinx RST | Howtos |
| charm READMEs | charmhub.io | OpenDev | Markdown | n/a |
| charm developer documentation | charmhub.io | Discourse | Markdown | Howtos, Concepts |
If at any time you are unsure about how to contribute to the
documentation do not hesitate to ask us questions <../contact>.