Contribute to documentation
There are a number of different ways to contribute to documentation at Grafana Labs. Choose the one that applies best and learn how you can engage with the documentation team and help by contributing your ideas.
Email docs@grafana.com
Report a problem when you want to make a suggestion or provide feedback about a topic, but don’t want to make the change yourself.
Reporting a problem gives you the freedom to express your ideas without committing language. Your suggestion can reflect a small change to wording or can reflect larger, more substantive changes.
You can report a problem through email by clicking the Email docs@grafana.com link that’s at the bottom of every documentation page.
Or you can email docs@grafana.com directly:
- Provide your feedback in the email body.
- Include a link to the current page.
- Send your email.
The Grafana Labs documentation team checks the email inbox regularly and responds to emails in a timely fashion.
Suggest an edit in GitHub
If you want to recommend a small change, such as suggesting a correction to a topic, you can edit the topic directly in GitHub.
Small changes might include:
- Adding steps to a task
- Adding clarifying language to a concept
- Providing an example
Before you begin
- Create a GitHub account.
- Find the source repository. To find the source repository, refer to Find the source repository.
Find the source repository
The “latest” and “next” versions of documentation published from public projects have a Suggest an edit in GitHub link with a pencil icon. Click this link to directly edit the page in GitHub.
Warning
Because development happens in the
mainbranch on GitHub which generally corresponds to the next version of documentation.The latest version of documentation is typically published from a different version branch, and the Suggest an edit link can result in a 404 error from GitHub.
In that case, you can use the GitHub code navigation to try and find the new location or reach out to the Grafana Labs documentation team for support.
If pages don’t have a Suggest an edit link, the documentation isn’t open source. Only Grafana Labs employees can update closed source documentation. If you’re not a Grafana Labs employee, you can still Email docs@grafana.com.
For example, Grafana Cloud documentation is in the website repository.
Note
The website repository is private and only accessible to Grafana Labs employees.
Some Grafana Cloud content is mounted from other projects. The list of mounts is in the website repository Hugo configuration file.
To edit a page
From a page on the documentation website, click Suggest an edit in GitHub.
Make your changes.
Click Propose changes.
GitHub creates a pull request which then goes through the review and approval workflow.
Develop a new topic
If you want to develop a new topic from scratch, you can create a documentation plan and collaborate with a member of the technical writing team. According to the book Docs for Developers, a documentation plan is a flexible outline for anticipating where the writing process will lead you.
Your documentation plan helps you to:
- Identify information gaps, and explain how to fill them.
- Get feedback from users and stakeholders before the writing process begins.
- Consider different approaches you might take, and decide on one of them.
Test your changes
It’s a best practice to have someone else test any task you have written. If another user can successfully complete the task using only the steps you have written, not guessing or using their inherent knowledge, then your task has passed the test. However, it’s very common to find you have skipped steps because you are very familiar with the topic you are explaining.
New users or members of other teams are very helpful for these tests.
Review your changes
Prior to pushing your changes to GitHub, you can view a local build of the documentation so that you can review your work. For more information on using Git, refer to Use Git.
To view a local build, refer to Test documentation changes
Push changes and create a pull request
When you are ready for other people to review your work, perform the following tasks:
Add your changes, which prepares your content for the next commit.
Commit your changes.
Push your changes to GitHub.
Create a pull request in GitHub.
When writing the description for your pull request, use GitHub keywords, for example “Fixes #1234”, to link your pull request to the issue and take advantage of GitHub automation for status updates and closing resolved issues.
Add the
type/docslabel, so the Grafana Labs documentation team can track the issue.The docs build system automatically conducts a series of tests to ensure that the content doesn’t conflict with other content in the docs repository.
Pull request review and approval workflow
When you add a pull request to a repository and assign the type/docs label, it’s added to a queue that’s regularly reviewed by a member of the Grafana Labs documentation team.
The Grafana Labs documentation team aims to review all PRs in a timely fashion.
Contribute across versions
When you edit the main branch of a project, it affects the content in the next directory of the website.
To edit a previous version, or latest (the most recent release), you must backport the changes into the long-lived version branches in the project repository.
To backport a change, use the backport <BRANCH> labels on the GitHub pull request.
For more information, refer to Backport changes.
Grot, the Grafana bot, automatically creates a backport pull request if the merge commit can be cherry-picked without a conflict. If this process fails due to a merge conflict, Grot posts a comment explaining how to manually backport the change.
