When you contribute to documentation, it is a good practice to build the docs on your local machine to make sure your changes appear as you expect. This README explains the process for doing that.
Docker >= 2.1.0.3
- In the command line, make sure you are in the docs folder:
cd docs. - Run
make docs. This launches a preview of the docs website athttp://localhost:3002/docs/grafana/latest/which will refresh automatically when changes to content in thesourcesdirectory are made.
Edit content in the sources directory.
Use the Hugo shortcode relref any time you are linking to other internal docs pages.
Edit sources/menu.yaml to make changes to the sidebar. Stop and rerun the make docs command for changes to take effect.
Images are currently hosted in the grafana/website repo.
When a PR is merged to master with changes in the docs directory, those changes are automatically synched to the grafana/website repo on the docs-grafana branch.
In order to make those changes live, open a PR in the website repo that merges the docs-grafana branch into master. Then follow the publishing guidelines in that repo.