Skip to content

Commit

Permalink
Move GCP only section out of tags section 🤦
Browse files Browse the repository at this point in the history
  • Loading branch information
mortenlj committed Jul 2, 2024
1 parent 6f7c4e8 commit 7ef1cd2
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions docs/technical/doc-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,37 +164,37 @@ We want to make sure that the links are consistent and easy to understand. We us
| Prometheus | :simple-prometheus: | `[:simple-prometheus: Open Prometheus](../)` |
| Grafana | :simple-grafana: | `[:simple-grafana: Open Grafana](../)` |

### Tags
### GCP only features

We use tags to categorize and group the content to make it easier to find, as an alternative to the navigation menu and search.
Features that are only available in GCP clusters should preferably be marked in a consistent way.

Tags are written in the front matter of the markdown file like so:
For that purpose, a macro is available to add a warning in the text:

```markdown title="page.md"
---
tags: [tag1, tag2]
---
# Aiven Redis

# Title
<<gcp_only("Aiven Redis")>>

...
Aiven Redis is ...
```

### GCP only features

Features that are only available in GCP clusters should preferably be marked in a consistent way.
### Tags

For that purpose, a macro is available to add a warning in the text:
We use tags to categorize and group the content to make it easier to find, as an alternative to the navigation menu and search.

Tags are written in the front matter of the markdown file like so:

```markdown title="page.md"
# Aiven Redis
---
tags: [tag1, tag2]
---

<<gcp_only("Aiven Redis")>>
# Title

Aiven Redis is ...
...
```


#### Which tags should I use?

Tags should group multiple related pages together.
Expand Down

0 comments on commit 7ef1cd2

Please sign in to comment.