Skip to content

Commit

Permalink
Document how to use labels (#885)
Browse files Browse the repository at this point in the history
Co-authored-by: Robby Milo <[email protected]>
  • Loading branch information
jdbaldry and robbymilo authored Oct 25, 2024
1 parent 1d57387 commit 523d3f5
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/sources/write/front-matter/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,20 +297,26 @@ Ideally, use single terms as opposed to phrases.
### Labels

Use the `labels` key to add one or more values that you want to appear before the topic title on the published page.
Only certain labels are supported.
The website only supports certain label values.

For `labels.products`, the supported values and the resulting published labels are as follows:

- `cloud`: <span class="badge docs-labels__product-cloud docs-labels__item">Grafana Cloud</span>
- `enterprise`: <span class="badge docs-labels__product-enterprise docs-labels__item">Enterprise</span>
- `oss`: <span class="badge docs-labels__product-oss docs-labels__item">Open source</span>

You should use all labels that apply to the page's content.
If a page has some open source content and some Grafana Cloud content, set both labels.

For `labels.stages`, the supported values and the resulting published labels are as follows:

- `beta`: <span class="badge docs-labels__stage docs-labels__item">Beta</span>
- `alpha`: <span class="badge docs-labels__stage docs-labels__item">Alpha</span>
- `experimental`: <span class="badge docs-labels__stage docs-labels__item">Experimental</span>

In general, each page should only have one stage label and it should apply to the whole page.
If a page has content with multiple different stages, you should use the appropriate [release lifecycle copy](https://grafana.com/docs/release-life-cycle/) in each section.

Labels can be inherited through cascading front matter.

For versioned projects, the `_index.md` file resides in the `website` repository.
Expand Down

0 comments on commit 523d3f5

Please sign in to comment.