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

Adds landing page instructions #929

Merged
merged 51 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
e5d46fa
Adds landing page instructions
brendamuir Dec 18, 2024
9a66c35
updates to shortcodes
brendamuir Dec 18, 2024
1a5a87c
update note markdown
brendamuir Dec 18, 2024
d1613c8
syntax updates
brendamuir Dec 18, 2024
d702d64
escape shortcodes
brendamuir Dec 18, 2024
3829911
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
74031db
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
d8a5f4c
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
0da64ea
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
a3d6a37
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
98368e0
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
58a7f66
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
1b60a04
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
ef6c348
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
bc32a12
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
2eeab48
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
e2bd372
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
ffe8e67
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
0feed23
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
40d0717
vale
brendamuir Dec 18, 2024
a4f43e7
cancelling vale rule
brendamuir Dec 18, 2024
1f22797
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
469e6f6
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
84cf77b
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
186619a
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
b97154e
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
4126f0d
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
d6ffa68
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
c7dae3b
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 18, 2024
c583151
Merge branch 'main' into add-landing-page
jdbaldry Dec 20, 2024
95fccfd
feedback from julie
brendamuir Dec 20, 2024
07b7e8a
Merge branch 'add-landing-page' of github.com:grafana/writers-toolkit…
brendamuir Dec 20, 2024
e2e2bd4
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 20, 2024
56c323e
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 20, 2024
7dda4f8
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 20, 2024
324de06
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 20, 2024
85cacb6
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 20, 2024
f503a45
julies feedback
brendamuir Dec 20, 2024
233a080
julies feedback
brendamuir Dec 20, 2024
690f28d
Fix first heading
jdbaldry Dec 20, 2024
2bea463
Merge branch 'add-landing-page' of github.com:grafana/writers-toolkit…
brendamuir Dec 20, 2024
9afd632
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 20, 2024
5fdd3ff
Update docs/sources/structure/topic-types/landing-page/index.md
brendamuir Dec 20, 2024
38dcfdb
fix snippet dash
brendamuir Dec 20, 2024
f84a74a
Fix syntax and highlighting
jdbaldry Dec 20, 2024
fa9bdd2
add landing page to topic types main page
brendamuir Dec 20, 2024
2fcf35a
Merge branch 'add-landing-page' of github.com:grafana/writers-toolkit…
brendamuir Dec 20, 2024
72c7bcc
add text to topic type
brendamuir Dec 20, 2024
6a13fcb
intro text for landing page
brendamuir Dec 20, 2024
8870126
fix alignment
brendamuir Dec 20, 2024
4e4a960
gets rid of dash
brendamuir Dec 20, 2024
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
3 changes: 3 additions & 0 deletions docs/sources/structure/topic-types/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ Depending on the needs of a particular product area, select a topic type from th
**[Tutorial](https://grafana.com/docs/writers-toolkit/structure/topic-types/tutorial/)**
: Provides procedures that users can safely reproduce and learn from. Answers the question: "Can you teach me to …?"

**[Landing page](https://grafana.com/docs/writers-toolkit/structure/topic-types/landing-page/)**
: Guides users to the documentation they are looking for by introducing topics related to a particular product, product area, or set of features.

<!-- vale Grafana.GoogleFirstPerson = YES -->

For your convenience, there are topic [templates](https://github.com/grafana/writers-toolkit/tree/main/docs/static/templates).
Expand Down
73 changes: 73 additions & 0 deletions docs/sources/structure/topic-types/landing-page/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
date: 2024-12-18
description: Learn how to create a landing page.
keywords:
- topic types
- template
- landing page
review_date: 2024-12-18
title: Create landing pages
---

# Create landing pages

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. 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 to the landing page or create an Introduction topic nested underneath the landing page.

1. Add the `hero` shortcode to the front matter.
brendamuir marked this conversation as resolved.
Show resolved Hide resolved

This shortcode becomes the banner at the top of the landing page.

Example:

```yaml
hero:
title: Grafana Alerting
level: 1
image: /media/docs/grafana-cloud/alerting-and-irm/grafana-icon-alerting.svg
width: 100
height: 100
description: Grafana Alerting allows you to learn about problems in your systems moments after they occur.
jdbaldry marked this conversation as resolved.
Show resolved Hide resolved
```

{{< admonition type="note" >}}
brendamuir marked this conversation as resolved.
Show resolved Hide resolved
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 the Explore heading.

brendamuir marked this conversation as resolved.
Show resolved Hide resolved
brendamuir marked this conversation as resolved.
Show resolved Hide resolved
Example:
brendamuir marked this conversation as resolved.
Show resolved Hide resolved

```yaml
cards:
title_class: pt-0 lh-1
items:
- title: Grafana Alerting
href: /docs/grafana-cloud/alerting-and-irm/alerting/
brendamuir marked this conversation as resolved.
Show resolved Hide resolved
brendamuir marked this conversation as resolved.
Show resolved Hide resolved
description: Allows you to learn about problems in your systems moments after they occur. Monitor your incoming metrics data or log entries and set up your Alerting system to watch for specific events or circumstances and then send notifications when those things are found.
logo: /media/docs/grafana-cloud/alerting-and-irm/grafana-icon-alerting.svg
brendamuir marked this conversation as resolved.
Show resolved Hide resolved
brendamuir marked this conversation as resolved.
Show resolved Hide resolved
height: 24
jdbaldry marked this conversation as resolved.
Show resolved Hide resolved
```

{{< 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.
brendamuir marked this conversation as resolved.
Show resolved Hide resolved

- 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 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` 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.
Loading