e8bfb21851
* Build: changing docs dev-environment I have added a new image that will include the auto-generated frontend docs so you don't have to generate those locally prior to running the doc container. This has a dependency on this PR: https://github.com/grafana/website/pull/2744 and that we publish a version of the `grafana/docs-devenv` image. * will ignore everything (even symbolic links) * fixed spelling. * added newline. * updated image name. |
||
|---|---|---|
| .. | ||
| 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 Yarn >= 1.22.4
Build the doc site
- On the command line, first change to 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 are made to content in thesourcesdirectory.
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 synced 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.