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
• Writing style guide

Below is a summary of all documentation sources for the OpenStack Charms project.

Summary of documentation sources

Published	Domain	Platform	Format	Diátaxis
Charm Guide	docs.openstack.org	OpenDev	Sphinx RST	Tutorials, Howtos, Concepts, Reference
Deploy Guide	docs.openstack.org	OpenDev	Sphinx RST	Howtos
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.