Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add Best practices title guidance #854

Merged
merged 6 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/sources/structure/topic-types/concept/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ A _concept_ topic includes the following elements:

- **Topic title:** Topic titles should be nouns, for example, _Grafana panels_.
By using this naming convention, readers are able to distinguish between conceptual topics and tasks that begin with verbs.
For best practice guidelines, use the title _Best practices_.
- **Introduction:** Include an introduction that explains what this topic is about.
- **Body:** Provide as much content as needed to explain the concept thoroughly.
There can be sections, visuals, and text in the body of a concept.
Expand Down
11 changes: 6 additions & 5 deletions docs/sources/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,12 @@ This page provides a summary of notable changes to Writers' Toolkit guidance.

## September 2024

| New guidance or change | Page |
| -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| Added preference for _end-to-end_ when talking about testing. | [Word list](/docs/writers-toolkit/write/style-guide/word-list/#end-to-end) |
| Added preference for _meta-monitoring_ when talking about monitoring other monitoring tools. | [Word list](/docs/writers-toolkit/write/style-guide/word-list/#meta-monitoring) |
| Added preference for use of _self-managed_ when talking about Grafana deployment methods. | [Word list](/docs/writers-toolkit/write/style-guide/word-list/#self-managed) |
| New guidance or change | Page |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Added preference for _end-to-end_ when talking about testing. | [Word list](/docs/writers-toolkit/write/style-guide/word-list/#end-to-end) |
| Added preference for _meta-monitoring_ when talking about monitoring other monitoring tools. | [Word list](/docs/writers-toolkit/write/style-guide/word-list/#meta-monitoring) |
| Added preference for use of _self-managed_ when talking about Grafana deployment methods. | [Word list](/docs/writers-toolkit/write/style-guide/word-list/#self-managed) |
| Added preference to use the title _Best practices_ for best practice guidelines | [Concept](/docs/writers-toolkit/structure/topic-types/concept/#concept-topic-structure) and [Word list](/docs/writers-toolkit/write/style-guide/word-list/#best-practices) |

## August 2024

Expand Down
7 changes: 5 additions & 2 deletions docs/sources/write/style-guide/word-list/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,11 @@ For more information refer to [Alerting Rules](https://prometheus.io/docs/promet
Don't confuse this with an [_alert rule_ ](#alert-rule).
{{< /admonition >}}

<!--
## B -->
## B

### Best practices

Use the title _Best practices_ for conceptual topics covering best practice guidelines.

## C

Expand Down