How to add docs to your charm or charm bundle on Charmhub

This document shows how to add docs to your charm or charm bundle page on Charmhub.

Prerequisites:

Contents:

  1. Create the docs on Discourse
  2. Link the docs from the source code

Create the docs on Discourse

On the Charmhub Discourse, click on the +New Topic button.

This will open up a split window, with an editor panel on the left and a preview panel on the right.

In the editor panel, update the title on the template "<charm / charm bundle name> docs - index", update the category to charm (it’s the same for bundles), and update the tags to docs and <charm / charm bundle name>.

Copy-paste the template below into the editor panel:

Because we wanted you to be able to see here both comments and target text, we enclosed the entire template within triple quotes, ```. Make sure to remove them before you start editing.


Expand to see the template
<!--
UPDATE THE TEMPLATE BELOW TO INTRODUCE YOUR CHARM:
-->

**A single sentence that says what the product is, succinctly and memorably** consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

**A paragraph of one to three short sentences, that describe what the product does.** Urna cursus eget nunc scelerisque viverra mauris in. Nibh mauris cursus mattis molestie a iaculis at vestibulum rhoncus est pellentesque elit. Diam phasellus vestibulum lorem sed

**A third paragraph of similar length, this time explaining what need the product meets.** Dui ut ornare lectus sit amet est. Nunc sed augue lacus viverra vitae congue eu consequat ac libero id faucibus nisl tincidunt eget nullam.

**Finally, a paragraph that describes whom the product is useful for.** Nunc non blandit massa enim nec dui nunc mattis enim. Ornare arcu odio ut sem nulla pharetra diam porttitor leo a diam sollicitudin tempor id eu. Ipsum dolor sit amet consectetur adipiscing elit pellentesque habitant.

<!--
For example:
CODE NAME OF CHARM, E.G., `TRAEFIK-K8S` is a [Kubernetes | Machine charm](https://juju.is/docs/olm/charmed-operator) for NAME OF UPSTREAM APPLICATION / SERVICE.

This charm automates the deployment and operation of [NAME OF UPSTREAM APPLICATION / SERVICE](LINK TO UPSTREAM APPLICATION / SERVICE) on any Kubernetes | Machine-type cloud.

As a result, it makes managing cloud operations for NAME OF UPSTREAM APPLICATION / SERVICE easier than ever before: to deploy, run `juju deploy NAME OF CHARM`; to SOME OTHER POPULAR OPERATION, run `juju...`; etc.

This charm will benefit anyone who is struggling with PROBLEM THE APPLICATION / SERVICE SOLVES, is interested in a solution based on NAME OF THE UPSTREAM APPLICATION, and wants it cloud-ready.
-->

<!-- 
IF YOU HAVE OVERVIEW PAGES FOR THE VARIOUS DIATAXIS (https://diataxis.fr/) CATEGORIES: UNCOMMENT AND UPDATE THE SECTION BELOW AS WELL.
-->

<!--

## In this documentation

| | |
|-|-|
| [Tutorial](/t/<discourse-ID>)</br> **Get started** - a hands-on introduction to Example Product for new users </br> | [How-to guides](/t/<discourse-ID>) </br> **Step-by-step guides** covering key operations and common tasks | 
| [Explanation](/t/<discourse-ID>) </br> Discussion and clarification of key topics | [Reference](/t/<discourse-ID>) </br> **Technical information** - specifications, APIs, architecture |

-->

<!--
UPDATE THE SECTION BELOW TO REFLECT YOUR CHARM'S DETAILS.
NOTE: FEEL FREE TO ADD ANY OTHER RELEVANT LINKS, E.G., A LINK TO THE CHARM'S DISCUSSION FORUM.
-->

## Project and community

Example Charm / Charm Bundle is a member of the Ubuntu family. It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.

* [Code of conduct](https://ubuntu.com/community/ethos/code-of-conduct)
* [Get support](<link>)
* [Join our online chat](<link>)
* [Contribute](<link>)
* [Roadmap](<link>)

Thinking about using Example Charm / Charm Bundle for your next project? [Get in touch!](<link>)

<!--IF YOU WANT TO SEE THIS DOC AS WELL AS FURTHER DOCS IN THE SIDE NAVIGATION OF THE DESCRIPTION TAB OF YOUR CHARM'S PAGE ON CHARMHUB: UNCOMMENT AND UPDATE THE NAVIGATION TABLE BELOW.

NOTES ON THE SYNTAX:
- LEVEL = NESTEDNESS LEVEL. CAN BE ONE OF 1, 2, 3.
- PATH = URL IN https://charmhub.io/CHARM-NAME/URL 
- NAVLINK = TITLE TO BE DISPLAYED IN THE SIDE-NAVIGATION OF THE DESCRIPTION TAB OF YOUR CHARM'S PAGE ON CHARMHUB ALONG WITH ITS TRUNCATED DISCOURSE LINK. TIP: IF YOU WANT THE TITLE TO SHOW IN NAVIGATION BUT DO NOT YET HAVE A PAGE TO ATTACH TO IT, YOU CAN LEAVE THE LINK EMPTY.

NOTES ON THE CONTENT:
- THE HOME PAGE IS THIS INDEX PAGE.
- TUTORIAL, HOW-TO GUIDES, REFERENCE, EXPLANATION ARE OVERVIEW PAGES FOR EACH DIATAXIS CATEGORY: https://diataxis.fr/ 
- THE PAGES NESTED UNDER REFERENCE ARE THE PREGENERATED ACTIONS, CONFIGURATIONS, INTEGRATIONS, LIBRARIES, RESOURCES TABS OF YOUR CHARM. THEY ALL CONTAIN REFERENCE-TYPE INFORMATION.


CAUTION: 
- ROWS WITH AN EMPTY LEVEL IN THE MIDDLE OF THE TABLE WILL CAUSE AN ERROR.
- ROWS COMMENTED OUT IN THE MIDDLE OF THE TABLE WILL CAUSE AN ERROR. 
-->

<!--

# Navigation

| Level | Path | Navlink |
| -- | -- | -- |
| 1 |  | [Home](/t/<discourse-ID-for-this-index-page>) |
| 1 | tutorial | [install](/t/<discourse-ID>) |
| 1 | how-to | [How-to guides](/t/<discourse-ID>) |
| 2 | configure | [Configure](/t/<discourse-ID>)
| 1 | reference | [Reference](/t/<discourse-ID>) |
| 2 | actions | [Actions](<link to charm's Charmhub actions tab>) |
| 2 | configurations | [Configurations](<link to charm's Charmhub configurations tab>) |
| 2 | integrations | [Integrations](<link to charm's Charmhub integrations tab>) |
| 2 | libraries | [Libraries](<link to charm's Charmhub libraries tab>) |
| 2 | resources | [Resources](<link to charm's Charmhub resources tab>)
| 1 | explanation | [Explanation](/t/<discourse-ID>) |

-->

<!--
IF YOU NEED TO REDIRECT FROM AN OLD URL TO A NEW URL, UNCOMMENT AND UPDATE THE REDIRECTS TABLE BELOW ON THE TEMPLATE: | /EXAMPLE-CHARM/docs/OLD-URL | /EXAMPLE-CHARM/docs/NEW-URL |
-->

<!--

# Redirects

[details=Mapping table]
| Path | Location |
| -- | -- |
[/details]

-->


In the editor window, follow all the “update” instructions in the comments to fill in the information for your charm / charm bundle.

(For now, ignore all the “uncomment and update” instructions. You will likely not be able to update the information there right away anyway. It is there primarily to give you a preview of what your documentation should look like in the end.)

Click + Create Topic to save and create the doc.

At this point you can start editing again, e.g., to uncomment and update the Navigation table with a row for the docs index page itself and potentially also other docs. Or you can leave that for a future iteration and go ahead and publish this doc to the charm’s page on Charmhub.

Do not wait for things to be perfect! Some documentation is better than none. If you’re happy with the Home page, but do not have time to work on other docs right away, do not wait – go ahead and publish! Just don’t forget to keep iterating!

In the metadata.yaml file of your charm / bundle.yaml of your bundle, add a docs field, passing as a value the full Discourse link of your charm / charm bundle’s docs index page:

docs: https//discourse.charmhub.io/t/<discourse-id>

See more: File metadata.yaml > docs, File bundle.yaml > docs

Once your change is merged into the repository’s main branch, go to the charm or charm bundle’s Charmhub page on the edge channel to view the docs. To do this, add the ?channel=edge URL param after the URL. For example, in the case of MLflow Server, the URL is https://charmhub.io/mlflow-server?channel=edge.

If you want to see the documentation on the charm / charm bundle’s main page (without the ?channel=edge URL param), you will need to build, push, and release your updated charm.

See more: How to publish your charm on Charmhub

Done!

Last updated 5 months ago. Help improve this document in the forum.