033feebbf9
* Document Update Where to were * Document Update "re enter" to "reenter" * Document Update "an" to "a" * Document Update "an" to "a" * Document update "can not " to cannot * Document update Changes made from "and by that not function as expected." to "and by that it do not function as expected." * Document update Change made from "by that not function as expected" to "by that it does not function as expected" * Update docs/sources/installation/upgrading.md Commit, the document based on suggestion Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> * Update docs/sources/installation/upgrading.md Commit the changes as per the suggestion Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> * Document update Changes reverted from "cannot" to "can not" as per the suggestion * Document Update Changes as per the suggestion * Document changes Changes as per the suggestion * Document Change Changes made as per the suggestion Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> |
||
|---|---|---|
| .. | ||
| sources | ||
| .gitignore | ||
| logo-horizontal.png | ||
| Makefile | ||
| README.md | ||
| versions.json | ||
Building the docs locally
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.
Requirements
Docker >= 2.1.0.3
Build the doc site
- 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.
Content guidelines
Edit content in the sources directory.
Using relref for internal links
Use the Hugo shortcode relref any time you are linking to other internal docs pages.
Edit the side menu
Edit sources/menu.yaml to make changes to the sidebar. Stop and rerun the make docs command for changes to take effect.
Add images
Images are currently hosted in the grafana/website repo.
Deploy changes to grafana.com
When a PR is merged to master with changes in the docs/sources directory, those changes are automatically synched to the grafana/website repo and published to the staging site.
Generally, someone from marketing will publish to production each day, so as long as the sync is successful your docs edits will be published. Alternatively, you can refer to publishing to production if you'd like to do it yourself.