From e5d46facc0b8377f6707176ae6a0068376eb6c97 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 11:12:46 +0100 Subject: [PATCH 01/47] Adds landing page instructions --- .../topic-types/landing-page/index.md | 97 +++++++++++++++++++ 1 file changed, 97 insertions(+) create mode 100644 docs/sources/structure/topic-types/landing-page/index.md diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md new file mode 100644 index 000000000..6ff52815f --- /dev/null +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -0,0 +1,97 @@ +--- +aliases: + - /docs/writers-toolkit/writing-guide/documentation-structure/topic-types/landing-page + - /docs/writers-toolkit/structure/topic-types/landing-page/ +date: "2022-10-27T16:43:50-04:00" +description: Learn how to create a landing page. +keywords: + - topic types + - template + - landing page +menuTitle: Landing page +review_date: "2024-06-07" +title: Landing page +--- + +# Landing page + +A landing page is a page, which introduces a series of topics related to a particular product, product area, or set of features. + +## Create landing pages + +Create a landing page as a starting point for customers to get access to the documentation they are 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/create an Introduction topic nested underneath the landing page. +1. Add the `hero` shortcode to the front matter. + + This shortcode becomes the banner at the top of the landing page. + + Example: + + ```markdown + 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. + ``` + {{< admonition type="note" >}} + 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. + + Start each description with a verb. + + {{< admonition type="note" >}} + 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. + {{< /admonition >}} + + Example: + + ```markdown + cards: + title_class: pt-0 lh-1 + items: + title: Grafana Alerting + href: /docs/grafana-cloud/alerting-and-irm/alerting/ + 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 + height: 24 + ``` + {{< admonition type="note" >}} + + If you are creating a landing page that appears in both Cloud and OSS, use a relative path (eg. ./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. + + Example: + + ```markdown + - - - + {{< docs/hero-simple key="hero" >}} + - - - + ``` + +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. + + Example: + + ```markdown + ## Explore + + {{< card-grid key="cards" type="simple" >}} + ``` + +1. Save your topic and build your documentation to review your changes. From 9a66c3578fa761aa1086e6500c94dac676b5545d Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 11:19:22 +0100 Subject: [PATCH 02/47] updates to shortcodes --- docs/sources/structure/topic-types/landing-page/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 6ff52815f..3f864131f 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -37,7 +37,7 @@ To create a landing page, complete the following steps. hero: title: Grafana Alerting level: 1 - image: /media/docs/grafana-cloud/alerting-and-irm/grafana-icon-alerting.svg + 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. @@ -73,7 +73,7 @@ To create a landing page, complete the following steps. 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. +1. To display the banner at the top of the page, add `{{< docs/hero-simple key="hero" >}}` after the front matter. Example: @@ -84,7 +84,7 @@ To create a landing page, complete the following steps. ``` 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. Add the ## Explore header and this syntax `{{< card-grid key="cards" type="simple" >}}` to display the tiles below. Example: From 1a5a87c0669aee6ca2f16cf382eea95af8a02e94 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:05:45 +0100 Subject: [PATCH 03/47] update note markdown --- .../structure/topic-types/landing-page/index.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 3f864131f..85851c74e 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -42,18 +42,19 @@ To create a landing page, complete the following steps. height: 100 description: Grafana Alerting allows you to learn about problems in your systems moments after they occur. ``` + ```markdown {{< admonition type="note" >}} 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. Start each description with a verb. - + ```markdown {{< admonition type="note" >}} 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. {{< /admonition >}} - + ``` Example: ```markdown @@ -66,13 +67,14 @@ To create a landing page, complete the following steps. logo: /media/docs/grafana-cloud/alerting-and-irm/grafana-icon-alerting.svg height: 24 ``` + ```markdown {{< admonition type="note" >}} If you are creating a landing page that appears in both Cloud and OSS, use a relative path (eg. ./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. Example: From d1613c8b56b1006fcb0771f92e075663dc0e60ff Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:12:05 +0100 Subject: [PATCH 04/47] syntax updates --- .../topic-types/landing-page/index.md | 32 ++++--------------- 1 file changed, 7 insertions(+), 25 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 85851c74e..923a96115 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -42,19 +42,19 @@ To create a landing page, complete the following steps. height: 100 description: Grafana Alerting allows you to learn about problems in your systems moments after they occur. ``` - ```markdown + {{< admonition type="note" >}} 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. Start each description with a verb. - ```markdown + {{< admonition type="note" >}} 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. {{< /admonition >}} - ``` + Example: ```markdown @@ -67,33 +67,15 @@ To create a landing page, complete the following steps. logo: /media/docs/grafana-cloud/alerting-and-irm/grafana-icon-alerting.svg height: 24 ``` - ```markdown + {{< admonition type="note" >}} If you are creating a landing page that appears in both Cloud and OSS, use a relative path (eg. ./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. - - Example: - - ```markdown - - - - - {{< docs/hero-simple key="hero" >}} - - - - - ``` +1. To display the banner at the top of the page, add {{< docs/hero-simple key="hero" >}} after the front matter. 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. - - Example: - - ```markdown - ## Explore - - {{< card-grid key="cards" type="simple" >}} - ``` - +1. Add the ## Explore header 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. From d702d6414336e9f7174f7d0c52d86eec3fa00eb2 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:16:18 +0100 Subject: [PATCH 05/47] escape shortcodes --- docs/sources/structure/topic-types/landing-page/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 923a96115..59ee35e3f 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -75,7 +75,7 @@ To create a landing page, complete the following steps. 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. +1. To display the banner at the top of the page, add {{}} after the front matter. 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. Add the ## Explore header and this syntax {{}} to display the tiles below. 1. Save your topic and build your documentation to review your changes. From 3829911c6c2d5155208fd39b06f05dcda341b96e Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:20:12 +0100 Subject: [PATCH 06/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 59ee35e3f..4487927ed 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -23,7 +23,7 @@ Create a landing page as a starting point for customers to get access to the doc 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. From 74031db03a0b94ad7bc573ce844f3f3c9d0543eb Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:21:09 +0100 Subject: [PATCH 07/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 4487927ed..b679aea6f 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -27,6 +27,7 @@ To create a landing page, complete the following steps. 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. + 1. Add the `hero` shortcode to the front matter. This shortcode becomes the banner at the top of the landing page. From d8a5f4c76160b8e38bd24c9c4dc38f89d0596d80 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:21:32 +0100 Subject: [PATCH 08/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index b679aea6f..55bc602a9 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -44,6 +44,7 @@ To create a landing page, complete the following steps. description: Grafana Alerting allows you to learn about problems in your systems moments after they occur. ``` + {{< admonition type="note" >}} You may have to adjust the width or height to 100/110 depending on the spacing. {{< /admonition >}} From 0da64ea27a984e6b9f32693c1c0eb33a83b4e25c Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:21:41 +0100 Subject: [PATCH 09/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../structure/topic-types/landing-page/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 55bc602a9..b952708e4 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -62,12 +62,12 @@ To create a landing page, complete the following steps. ```markdown cards: title_class: pt-0 lh-1 - items: - title: Grafana Alerting - href: /docs/grafana-cloud/alerting-and-irm/alerting/ - 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 - height: 24 + items: + title: Grafana Alerting + href: /docs/grafana-cloud/alerting-and-irm/alerting/ + 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 + height: 24 ``` {{< admonition type="note" >}} From a3d6a37862b6b02f55cf8d31783062cb6ac9f0f3 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:21:50 +0100 Subject: [PATCH 10/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index b952708e4..643230f34 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -49,7 +49,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 ## Explore. Start each description with a verb. From 98368e0f499e6483b84fa48d7562df8d55d91871 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:22:01 +0100 Subject: [PATCH 11/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 643230f34..bdfdbb8a5 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -70,6 +70,7 @@ To create a landing page, complete the following steps. height: 24 ``` + {{< admonition type="note" >}} If you are creating a landing page that appears in both Cloud and OSS, use a relative path (eg. ./set-up). From 58a7f66ae7ddf6aa05c964d817ed18c22bca52a6 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:22:23 +0100 Subject: [PATCH 12/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: Jack Baldry --- docs/sources/structure/topic-types/landing-page/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index bdfdbb8a5..e8f42275e 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -2,7 +2,7 @@ aliases: - /docs/writers-toolkit/writing-guide/documentation-structure/topic-types/landing-page - /docs/writers-toolkit/structure/topic-types/landing-page/ -date: "2022-10-27T16:43:50-04:00" +date: 2024-12-18 description: Learn how to create a landing page. keywords: - topic types From 1b60a049e334e9b5d690a2ed775b6bc4b6e3356d Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:22:30 +0100 Subject: [PATCH 13/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index e8f42275e..bb8a8af68 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -39,9 +39,9 @@ To create a landing page, complete the following steps. 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. + width: 100 + height: 100 + description: Grafana Alerting allows you to learn about problems in your systems moments after they occur. ``` From ef6c34895a81b055cf0181c73fe3dee7c5a95d58 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:22:49 +0100 Subject: [PATCH 14/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: Jack Baldry --- docs/sources/structure/topic-types/landing-page/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index bb8a8af68..69f64c18c 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -9,7 +9,7 @@ keywords: - template - landing page menuTitle: Landing page -review_date: "2024-06-07" +review_date: 2024-12-18 title: Landing page --- From bc32a12313e4d9c0aa31d0d98d5ef2a1907e2a47 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:23:05 +0100 Subject: [PATCH 15/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 69f64c18c..a74a7c8d4 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -51,7 +51,10 @@ To create a landing page, complete the following steps. 1. Add the `card-grid` shortcode to the front matter. This shortcode is for the tiles that appear below ## Explore. - Start each description with a verb. +1. Add the `card-grid` shortcode to the front matter. This shortcode is for the tiles that appear below ## Explore. + + Start each description with a verb. + {{< admonition type="note" >}} 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. From 2eeab48ca26ab7f7e9e77bdb3039c3c08c8a0c6f Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:23:24 +0100 Subject: [PATCH 16/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index a74a7c8d4..bd9146588 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -60,6 +60,7 @@ To create a landing page, complete the following steps. 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. {{< /admonition >}} + Example: ```markdown From e2bd3721551ac5b7b151c44fca590866da830c57 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:23:39 +0100 Subject: [PATCH 17/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index bd9146588..92c2ea313 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -44,7 +44,6 @@ To create a landing page, complete the following steps. description: Grafana Alerting allows you to learn about problems in your systems moments after they occur. ``` - {{< admonition type="note" >}} You may have to adjust the width or height to 100/110 depending on the spacing. {{< /admonition >}} From ffe8e676d70a8ae96e3f27723a1ce491cd34e7fd Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:24:19 +0100 Subject: [PATCH 18/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 92c2ea313..be1a649ad 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -73,7 +73,6 @@ To create a landing page, complete the following steps. height: 24 ``` - {{< admonition type="note" >}} If you are creating a landing page that appears in both Cloud and OSS, use a relative path (eg. ./set-up). From 0feed23aa8f43abf495bf500b5455fc2c3e189f5 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:24:37 +0100 Subject: [PATCH 19/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index be1a649ad..a80d4f72a 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -59,7 +59,6 @@ To create a landing page, complete the following steps. 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. {{< /admonition >}} - Example: ```markdown From 40d0717dec165603750a82fcb029bf35fe4db725 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:27:31 +0100 Subject: [PATCH 20/47] vale --- docs/sources/structure/topic-types/landing-page/index.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index a80d4f72a..418053588 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -1,7 +1,4 @@ --- -aliases: - - /docs/writers-toolkit/writing-guide/documentation-structure/topic-types/landing-page - - /docs/writers-toolkit/structure/topic-types/landing-page/ date: 2024-12-18 description: Learn how to create a landing page. keywords: @@ -74,9 +71,9 @@ To create a landing page, complete the following steps. {{< admonition type="note" >}} - If you are creating a landing page that appears in both Cloud and OSS, use a relative path (eg. ./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 don’t have an icon, delete `logo` from the front matter. + Icons are only required for products. If you do not have an icon, delete `logo` from the front matter. {{< /admonition >}} 1. To display the banner at the top of the page, add {{}} after the front matter. From a4f43e7dfdb2f509493c403c74447ac7f2580c39 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:38:15 +0100 Subject: [PATCH 21/47] cancelling vale rule --- docs/sources/structure/topic-types/landing-page/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 418053588..51b0511bf 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -9,9 +9,9 @@ menuTitle: Landing page review_date: 2024-12-18 title: Landing page --- - + # Landing page - + A landing page is a page, which introduces a series of topics related to a particular product, product area, or set of features. ## Create landing pages From 1f22797182b884022e29637123f714f4e7ad5511 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:39:11 +0100 Subject: [PATCH 22/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 51b0511bf..dc84052a1 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -9,6 +9,7 @@ menuTitle: Landing page review_date: 2024-12-18 title: Landing page --- + # Landing page From 469e6f6871c81149bbd7ae86c8d3b0f46198bfbf Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:39:18 +0100 Subject: [PATCH 23/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index dc84052a1..3607022a6 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -12,6 +12,7 @@ title: Landing page # Landing page + A landing page is a page, which introduces a series of topics related to a particular product, product area, or set of features. From 84cf77b4e7f555ce962afec7b0998447d1cd6f19 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:39:27 +0100 Subject: [PATCH 24/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 3607022a6..3306b376a 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -11,6 +11,7 @@ title: Landing page --- + # Landing page From 186619a5be658cc10f145720e47f8679e66468e2 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:39:34 +0100 Subject: [PATCH 25/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 3306b376a..691b6908e 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -15,6 +15,7 @@ title: Landing page # Landing page + A landing page is a page, which introduces a series of topics related to a particular product, product area, or set of features. ## Create landing pages From b97154e095697b1c9e8488ad974fa91f9554cbd5 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:39:51 +0100 Subject: [PATCH 26/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 691b6908e..c8b3cc1aa 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -55,7 +55,6 @@ To create a landing page, complete the following steps. Start each description with a verb. - {{< admonition type="note" >}} 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. {{< /admonition >}} From 4126f0dc4c26553b8b4cb4d355dfad37fe0935d8 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:39:58 +0100 Subject: [PATCH 27/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index c8b3cc1aa..f647f6815 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -12,7 +12,8 @@ title: Landing page -# Landing page + + From d6ffa68b57a92ebcd1ac7ce3eb3009e00820d095 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:40:21 +0100 Subject: [PATCH 28/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index f647f6815..ea2eb0872 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -17,7 +17,8 @@ title: Landing page -A landing page is a page, which introduces a series of topics related to a particular product, product area, or set of features. + + ## Create landing pages From c7dae3b50f8b568616e71ac3fb6acb43bf1b46f0 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:40:32 +0100 Subject: [PATCH 29/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index ea2eb0872..ea0e35ed0 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -12,9 +12,6 @@ title: Landing page - - - From 95fccfd1d6dfbdc5c4b326d69c2d121b23a83229 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 10:36:12 +0100 Subject: [PATCH 30/47] feedback from julie --- .../structure/topic-types/landing-page/index.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index ea0e35ed0..6c1611e4f 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -50,14 +50,6 @@ To create a landing page, complete the following steps. 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 ## Explore. - - Start each description with a verb. - - {{< admonition type="note" >}} - 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. - {{< /admonition >}} - Example: ```markdown @@ -70,12 +62,15 @@ 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" >}} - If you are creating a landing page that appears in both Cloud and OSS, use a relative path, for example, ./set-up. + - 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 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. + - Icons are only required for products. If you do not have an icon, delete `logo` from the front matter. {{< /admonition >}} 1. To display the banner at the top of the page, add {{}} after the front matter. From e2e2bd4eb48944c93811f5b7a2d59d1478f95b9c Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:32:36 +0100 Subject: [PATCH 31/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 6c1611e4f..028940fb2 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -70,8 +70,8 @@ To create a landing page, complete the following steps. - 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 do not have an icon, delete `logo` from the front matter. + {{< /admonition >}} 1. To display the banner at the top of the page, add {{}} after the front matter. 1. Add the ## Overview header and your content. From 56c323e1ebfd4d696992b12c1bf506f07d82020e Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:32:45 +0100 Subject: [PATCH 32/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 028940fb2..e457a0a3f 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -68,7 +68,7 @@ To create a landing page, complete the following steps. 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 >}} From 7dda4f8b10476ef6873411036fd327504e36f6f9 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:32:53 +0100 Subject: [PATCH 33/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index e457a0a3f..3ecf2b015 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -66,7 +66,7 @@ To create a landing page, complete the following steps. - 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. From 324de0639eee86403c88d7b2ad7a93f216fb754a Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:33:03 +0100 Subject: [PATCH 34/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 3ecf2b015..18f95816b 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -64,7 +64,7 @@ To create a landing page, complete the following steps. ``` {{< admonition type="note" >}} - - Start each description with a verb. + - 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. From 85cacb6a2963b58aaf0327f34efc11833ba30be8 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:33:22 +0100 Subject: [PATCH 35/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/sources/structure/topic-types/landing-page/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 18f95816b..a46831de0 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -66,7 +66,7 @@ To create a landing page, complete the following steps. - 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. From f503a45eccb33c7f6515099e9c3def103d3958a9 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:35:47 +0100 Subject: [PATCH 36/47] julies feedback --- docs/sources/structure/topic-types/landing-page/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index a46831de0..bcbc69c27 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -73,7 +73,7 @@ To create a landing page, complete the following steps. - Icons are only required for products. If you do not have an icon, delete `logo` from the front matter. {{< /admonition >}} -1. To display the banner at the top of the page, add {{}} after the front matter. +1. To display the banner at the top of the page, add {{}} 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 {{}} to display the tiles below. 1. Save your topic and build your documentation to review your changes. From 233a080e29b3f4b956c4826866d605a8e3826237 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:35:47 +0100 Subject: [PATCH 37/47] julies feedback Signed-off-by: Jack Baldry --- .../topic-types/landing-page/index.md | 34 ++++++++----------- 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index a46831de0..afee83b95 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -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 --- - - - - - - - ## 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. @@ -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: @@ -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 {{}} after the front matter. -1. Add the ## Overview header and your content. -1. Add the ## Explore header and this syntax {{}} to display the tiles below. +1. To display the banner at the top of the page, add `{{}}` 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 `{{}}` to display the tiles below. 1. Save your topic and build your documentation to review your changes. From 690f28d085d700d0989032ff26cca5d08add3261 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Fri, 20 Dec 2024 10:43:10 +0000 Subject: [PATCH 38/47] Fix first heading --- docs/sources/structure/topic-types/landing-page/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index afee83b95..3aacb33ce 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -9,7 +9,7 @@ review_date: 2024-12-18 title: Create landing pages --- -## 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. From 9afd6322162d2d9ef6ed8435f753acb0ae760a74 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 13:09:26 +0100 Subject: [PATCH 39/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: Jack Baldry --- .../structure/topic-types/landing-page/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 3aacb33ce..8723cf48a 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -28,12 +28,12 @@ To create a landing page, complete the following steps. ```markdown 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. + 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. ``` {{< admonition type="note" >}} From 5fdd3ff2b3ae0a2475bf7d43206fff4e4bedf6b1 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 13:09:38 +0100 Subject: [PATCH 40/47] Update docs/sources/structure/topic-types/landing-page/index.md Co-authored-by: Jack Baldry --- .../structure/topic-types/landing-page/index.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 8723cf48a..0e77d10a7 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -46,13 +46,13 @@ To create a landing page, complete the following steps. ```markdown cards: - title_class: pt-0 lh-1 - items: - title: Grafana Alerting - href: /docs/grafana-cloud/alerting-and-irm/alerting/ - 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 - height: 24 + title_class: pt-0 lh-1 + items: + - title: Grafana Alerting + href: /docs/grafana-cloud/alerting-and-irm/alerting/ + 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 + height: 24 ``` {{< admonition type="note" >}} From 38dcfdbe9276a95bf6b185ca7557f215de49b6df Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 13:16:21 +0100 Subject: [PATCH 41/47] fix snippet dash --- docs/sources/structure/topic-types/landing-page/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 0e77d10a7..d5cf32864 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -48,7 +48,7 @@ To create a landing page, complete the following steps. cards: title_class: pt-0 lh-1 items: - - title: Grafana Alerting + title: Grafana Alerting href: /docs/grafana-cloud/alerting-and-irm/alerting/ 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 From f84a74ac712e89390b3622637b840d6d95c349cd Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Fri, 20 Dec 2024 12:21:12 +0000 Subject: [PATCH 42/47] Fix syntax and highlighting Signed-off-by: Jack Baldry --- docs/sources/structure/topic-types/landing-page/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index d5cf32864..6565af97f 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -26,7 +26,7 @@ To create a landing page, complete the following steps. Example: - ```markdown + ```yaml hero: title: Grafana Alerting level: 1 @@ -44,11 +44,11 @@ To create a landing page, complete the following steps. Example: - ```markdown + ```yaml cards: title_class: pt-0 lh-1 items: - title: Grafana Alerting + - title: Grafana Alerting href: /docs/grafana-cloud/alerting-and-irm/alerting/ 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 From fa9bdd28529dc9acaf6f08811f3dd7cea25ca520 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 14:25:48 +0100 Subject: [PATCH 43/47] add landing page to topic types main page --- docs/sources/structure/topic-types/_index.md | 2 ++ docs/sources/structure/topic-types/landing-page/index.md | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/_index.md b/docs/sources/structure/topic-types/_index.md index 0549f3905..af937ba98 100644 --- a/docs/sources/structure/topic-types/_index.md +++ b/docs/sources/structure/topic-types/_index.md @@ -36,6 +36,8 @@ 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/)) + For your convenience, there are topic [templates](https://github.com/grafana/writers-toolkit/tree/main/docs/static/templates). diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index d5cf32864..1e26a8bbc 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -48,7 +48,7 @@ To create a landing page, complete the following steps. cards: title_class: pt-0 lh-1 items: - title: Grafana Alerting + ctitle: Grafana Alerting href: /docs/grafana-cloud/alerting-and-irm/alerting/ 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 From 72c7bcccc308b8ad1a3162e895960e8603830049 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 14:30:41 +0100 Subject: [PATCH 44/47] add text to topic type --- docs/sources/structure/topic-types/landing-page/index.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index e773e1c9a..6565af97f 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -48,11 +48,7 @@ To create a landing page, complete the following steps. cards: title_class: pt-0 lh-1 items: -<<<<<<< HEAD - ctitle: Grafana Alerting -======= - title: Grafana Alerting ->>>>>>> f84a74ac712e89390b3622637b840d6d95c349cd href: /docs/grafana-cloud/alerting-and-irm/alerting/ 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 From 6a13fcbf6e5b62da3a577946a3e8b224a1ea7bda Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 14:37:57 +0100 Subject: [PATCH 45/47] intro text for landing page --- docs/sources/structure/topic-types/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/_index.md b/docs/sources/structure/topic-types/_index.md index af937ba98..1d9fe732e 100644 --- a/docs/sources/structure/topic-types/_index.md +++ b/docs/sources/structure/topic-types/_index.md @@ -36,7 +36,7 @@ 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/)) +**[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. From 887012674dcd95fb8f3caa07c044b772173e9aab Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 14:40:20 +0100 Subject: [PATCH 46/47] fix alignment --- docs/sources/structure/topic-types/_index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/_index.md b/docs/sources/structure/topic-types/_index.md index 1d9fe732e..6a9207694 100644 --- a/docs/sources/structure/topic-types/_index.md +++ b/docs/sources/structure/topic-types/_index.md @@ -36,7 +36,8 @@ 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. +**[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. From 4e4a960b9329373a35c6b3acf46ed21ff28e7eaa Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 20 Dec 2024 14:42:26 +0100 Subject: [PATCH 47/47] gets rid of dash --- docs/sources/structure/topic-types/landing-page/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/structure/topic-types/landing-page/index.md b/docs/sources/structure/topic-types/landing-page/index.md index 6565af97f..f15d77474 100644 --- a/docs/sources/structure/topic-types/landing-page/index.md +++ b/docs/sources/structure/topic-types/landing-page/index.md @@ -18,7 +18,7 @@ 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. + 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.