Skip to content

Commit

Permalink
Review "Concept topic" (#540)
Browse files Browse the repository at this point in the history
  • Loading branch information
jdbaldry authored Feb 26, 2024
1 parent a87b371 commit 866e27c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 21 deletions.
Binary file not shown.
39 changes: 18 additions & 21 deletions docs/sources/structure/topic-types/concept/index.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
---
title: Concept topic
menuTitle: Concept
description: Learn how to write a concept topic.
weight: 100
aliases:
- /docs/writers-toolkit/writing-guide/documentation-structure/topic-types/concept
- /docs/writers-toolkit/structure/topic-types/concept
date: 2024-02-26
description: Learn how to write a concept topic.
keywords:
- topic types
- template
- concept
menuTitle: Concept
title: Concept topic
weight: 100
---

# Concept topic

A concept provides an overview and background information to help end users understand a product, interface, or task. Concepts answer the question “what is it?”. Readers learn about features through concepts.
A concept provides an overview and background information to help end users understand a product, interface, or task.
Concepts answer the question “what is it?”. Readers learn about features through concepts.

The following types of content can be included in concepts:

Expand All @@ -24,7 +26,7 @@ The following types of content can be included in concepts:
- Best practice guidelines
- An example of how a feature is used. Examples might include screenshots or other supporting visuals

A concept topic does not include:
A concept topic doesn't include:

- Step-by-step instructions
- Reference information, such as lookup tables or lists of values
Expand All @@ -33,13 +35,13 @@ A concept topic does not include:

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.
- **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.
- **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.
- **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.

<figure>
<img src="concept.png" alt="Concept structure" width="600">
</figure>
{{< figure src="https://grafana.com/media/docs/writers-toolkit/concept.png" alt="Annotated example of a concept page's structure" >}}

## Write a concept topic

Expand All @@ -51,28 +53,23 @@ To write a concept topic, follow these steps.
- Use a noun
- Use lowercase letters
- Add a hyphen between words
<br>
<br>
For example: - organization-management - alert-groups - installation - service-accounts
<br>
<br>

1. Within the parent directory, create an `_index.md` file.
1. Add front matter to the `_index` file.

For more information about front matter, refer to [Front matter]({{< relref "../../../write/front-matter" >}}).
For more information about front matter, refer to [Front matter](https://grafana.com/docs/writers-toolkit/write/front-matter/).

1. Add the content to a copy of the [Concept template](https://github.com/grafana/writers-toolkit/blob/main/docs/static/templates/concept-template.md).

For more information about the kinds of content you can add to a concept topic, refer to [Concept topics](#concept-topic).
For more information about the kinds of content you can add to a concept topic, refer to [Concept topic](#concept-topic).

## Concept topic examples

Refer to the following topics for concept topic examples:

- [Roles and permissions](/docs/grafana/latest/administration/roles-and-permissions/)
- [Deployment modes](/docs/loki/next/fundamentals/architecture/deployment-modes/)
- [Best practices for managing dashboards](/docs/grafana/latest/best-practices/best-practices-for-managing-dashboards/)
- [Roles and permissions](https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/)
- [Deployment modes](https://grafana.com/docs/loki/latest/get-started/deployment-modes/)
- [Grafana dashboard best practices](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/best-practices/)

## Concept template

Expand Down

0 comments on commit 866e27c

Please sign in to comment.