2.7 KiB
Contributing to documentation
This documents guides you through the process of contributing to the Grafana documentation. Make sure you've read the guide for Contributing to Grafana.
Your first contribution
If you’re unsure about where to start, check out some of our open docs issues.
Sometimes it can be difficult to understand an issue when you're just getting started. Refer to this list of beginner-friendly issues for tasks suitable for first-time contributors.
When you’ve found an issue you want to work on, please comment on the issue to let other people know you intend to work on it.
If you encounter any misspellings or violations to the style guide, please let us know by submitting an issue (or just fix them if they are minor changes).
On every page in the documentation are two links in the upper right corner:
- Edit this page takes you directly to the file on GitHub where you can contribute a fix.
- Request doc changes prepares an issue on GitHub with relevant information already filled in.
Join our community
For general discussions on documentation, you’re welcome to join the #docs channel on our public Grafana Slack team.
Style and formatting
All Grafana documentation is written using Markdown, and can be found in the docs directory in the Grafana GitHub repository. The documentation website is generated with Hugo which uses Blackfriday as its Markdown rendering engine.
Documentation structure
The Grafana documentation is organized into topics, called sections. You can take a look at the current build at grafana.com/docs/.
Each top-level section is located under the docs/sources directory. Subsections are added by creating a subdirectory in the directory of the parent section.
For each section, an _index.md file provides an overview of the topic.
Style guide
Refer to the Documentation style guide for information about Grafana style, word choice, and grammar conventions.
Spelling
The codespell tool is run for every change to catch common misspellings.