Skip to content

Commit

Permalink
Merge branch 'add-landing-page' of github.com:grafana/writers-toolkit…
Browse files Browse the repository at this point in the history
… into add-landing-page
  • Loading branch information
brendamuir committed Dec 20, 2024
2 parents f503a45 + 690f28d commit 2bea463
Showing 1 changed file with 15 additions and 21 deletions.
36 changes: 15 additions & 21 deletions docs/sources/structure/topic-types/landing-page/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,20 @@ keywords:
- topic types
- template
- landing page
menuTitle: Landing page
review_date: 2024-12-18
title: Landing page
title: Create landing pages
---

<!-- vale Grafana.Gerunds = NO -->
# Create landing pages

<!-- vale GGrafana.Gerunds = YES -->




## Create landing pages

Create a landing page as a starting point for customers to get access to the documentation they are looking for.
Create a landing page as a starting point for customers to get access to the documentation they're looking for.

To create a landing page, complete the following steps.

1. Go to the folder and \_index.md file for your landing page topic.
1. Go to the folder and `_index.md` file for your landing page topic.
1. Double-check existing front matter. You can leave existing front matter as is.

If there is useful text in the existing landing page - add it/create an Introduction topic nested underneath the landing page.
If there is useful text in the existing landing page - add it to the landing page or create an Introduction topic nested underneath the landing page.

1. Add the `hero` shortcode to the front matter.

Expand All @@ -48,7 +40,7 @@ To create a landing page, complete the following steps.
You may have to adjust the width or height to 100/110 depending on the spacing.
{{< /admonition >}}

1. Add the `card-grid` shortcode to the front matter. This shortcode is for the tiles that appear below ## Explore.
1. Add the `card-grid` shortcode to the front matter. This shortcode is for the tiles that appear below the Explore heading.

Example:

Expand All @@ -62,18 +54,20 @@ To create a landing page, complete the following steps.
logo: /media/docs/grafana-cloud/alerting-and-irm/grafana-icon-alerting.svg
height: 24
```

{{< admonition type="note" >}}

- Start each description with a verb.

If left empty, the description for the tile is automatically inherited from the short description front matter in the linked page. The descriptions in the front matter, however, are often short and it might be a good idea to add more context, making sure they all start with a verb for consistency.
If left empty, the description for the tile is automatically inherited from the short description front matter in the linked page. The descriptions in the front matter, however, are often short and it might be a good idea to add more context, making sure they all start with a verb for consistency.

- If you are creating a landing page that appears in both Cloud and OSS, use a relative path, for example, ./set-up.
- If you are creating a landing page that appears in both Cloud and OSS, use a relative path, for example, `./set-up/`.

- Icons are only required for products. If you do not have an icon, delete `logo` from the front matter.
{{< /admonition >}}
- Icons are only required for products. If you don't have an icon, delete `logo` from the front matter.

{{< /admonition >}}

1. To display the banner at the top of the page, add {{</* docs/hero-simple key="hero" */>}} after the front matter. This needs to come before the first heading.
1. Add the ## Overview header and your content.
1. Add the ## Explore header and this syntax {{</* card-grid key="cards" type="simple" */>}} to display the tiles below.
1. To display the banner at the top of the page, add `{{</* docs/hero-simple key="hero" */>}}` after the front matter. This needs to come before the first heading.
1. Add the `## Overview` heading and your content.
1. Add the `## Explore` heading and this syntax `{{</* card-grid key="cards" type="simple" */>}}` to display the tiles below.
1. Save your topic and build your documentation to review your changes.

0 comments on commit 2bea463

Please sign in to comment.