docs: lint README for Grafana Labs style #475
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
https://grafana.com/docs/writers-toolkit/ - Simplify some language for improved readability - Prefer [semantic line breaks](https://sembr.org/) for better line based diffing in the GitHub UI. - Format with Prettier - Prefer active voice and present tense Signed-off-by: Jack Baldry <[email protected]>
jdbaldry
changed the title
iainlane
approved these changes
Oct 16, 2024
There was a problem hiding this comment.
Looks great, thanks for splitting 👍
Here are two optional suggestions for this PR or another one if you fancy them:
Do you think we could come up with something to put in CONTRIBUTING.md that we can refer to when reviewing PRs, and point people to when asking for changes?
Also, you mentioned Vale. Don't suppose you have anything we could include here to run/enforce Vale checks? If not... a shared-workflows action to do that - wouldn't that be nice? (Or it can live with the writers' toolkit) 😁
| A public-facing, centralized place to store reusable GitHub workflows and action | ||
| used by Grafana Labs. See the `actions/` directory for the individual actions | ||
| themselves. | ||
| A public-facing, centralized place to store reusable workflows and GitHub Actions used by Grafana Labs. |
There was a problem hiding this comment.
The word "public-facing" on this repository's README has always grated on me. I wonder if we can come up with a better way to phrase this sentence.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our documentation style guide is in https://grafana.com/docs/writers-toolkit/