Skip to content

Commit

Permalink
Lint README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Jack Baldry <[email protected]>
  • Loading branch information
jdbaldry committed Jun 27, 2024
1 parent b736933 commit 6f38cfa
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,31 @@
# Writers’ Toolkit

<!-- vale Grafana.Exclamation = NO -->
<!-- vale Grafana.GoogleExclamation = NO -->
<!-- vale Grafana.We = NO -->

Welcome!

<!-- vale Grafana.Exclamation = YES -->

We're glad you're here to help make our technical documentation even better. We develop content that leads our users to success using Grafana products. Technical accuracy is our primary consideration, and we value the use of inclusive language. We regard your feedback as a gift - thanks for reading through these guidelines.
We're glad you're here to help make our technical documentation even better.
We develop content that leads our users to success using Grafana products.
Technical accuracy is our primary consideration, and we value the use of inclusive language.
We regard your feedback as a gift - thanks for reading through these guidelines.

## Intended audience

We write these guidelines for contributors who are interested in improving our technical content.
We write these guidelines for contributors who're interested in improving our technical content.

## Ways to contribute

We're thrilled that you are considering contributing to these writing guidelines. You can contribute content in the following ways:
We're thrilled that you are considering contributing to these writing guidelines.
You can contribute content in the following ways:

- Request a change
- Edit a topic
- Write a topic

## Understanding the PR review and approval workflow
## Pull request review and approval workflow

When you add a PR to the repo with a label associated with `type/docs`, it will be reviewed by a member of the technical writing team. Depending on the size of the PR and the priority of other work, the PR will either be immediately reviewed and merged (minor fixes typically follow this pattern) or the PR will be triaged and placed in the backlog of work or moved into further development.
When you open a pull request to this repository, the [CODEOWNERS](.github/CODEOWNERS) are notified for review.
Pull requests are generally reviewed and merged [within a working day](https://ossinsight.io/analyze/grafana/writers-toolkit#pull-requests:~:text=Pull%20Request%20Time%20Cost).

Thank you for reading these guidelines and contributing to Grafana Labs technical documentation!

0 comments on commit 6f38cfa

Please sign in to comment.