New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Please add documentation to relation library #49

Open

mthaddon opened this issue Sep 2, 2022 · 0 comments

mthaddon commented Sep 2, 2022

It would be very useful to have some documentation on how to use https://github.com/canonical/mongodb-k8s-operator/blob/main/lib/charms/mongodb_k8s/v0/mongodb.py.

If you add a multiline docstring at the top of this file it will be rendered as documentation on charmhub, making it easier for charm authors to integrate with your charm. As an example see https://charmhub.io/nginx-ingress-integrator/libraries/ingress and the corresponding documentation in https://github.com/canonical/nginx-ingress-integrator-operator/blob/main/lib/charms/nginx_ingress_integrator/v0/ingress.py.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment