DocumentationWriters' ToolkitBuild and review

Build and review documentation

You should test any content that you create before you create a pull request. Reviewers use the same tooling to review pull requests.

The build and review section covers the follow topics:

• Test documentation changes
  Test documentation changes by running a local documentation web server
• Lint prose with the Vale linter
  How to lint prose for Grafana Labs style with the Vale linter.
• Automated validation with doc-validator
  How to validate Grafana Labs technical documentation with the doc-validator tool.
• Backport changes
  Understand how and when to backport changes to Grafana repositories.
• Contributor License Agreement (CLA) assistant
  Understand the CLA assistant and its use on GitHub pull requests in Grafana repositories.

Last reviewed: May 22, 2024