From f29b0589277289daa3400b93d2e2331e97ef4dff Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Wed, 31 May 2023 16:52:03 +0100 Subject: [PATCH] Update cascading front matter to use sequence form (#67094) * Update cascading front matter to use sequence form The map form does not override the sequence form that is used in the website repository to specify the default labels. For more information, refer to https://github.com/grafana/writers-toolkit/pull/234. Signed-off-by: Jack Baldry * Remove useless alias Signed-off-by: Jack Baldry * Update labels for pages noted in code review Signed-off-by: Jack Baldry * Move all product labeling to the project index file All changes can be made in a single place. Signed-off-by: Jack Baldry * Move all individual page product labels to project index file Signed-off-by: Jack Baldry * Shorten YAML Signed-off-by: Jack Baldry * Add newlines to aid readability Signed-off-by: Jack Baldry * Document front matter ordering Signed-off-by: Jack Baldry * Rewrite labels for breaking-changes pages Signed-off-by: Jack Baldry * updated labels for whats new and breaking changes --------- Signed-off-by: Jack Baldry Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --- docs/sources/_index.md | 193 ++++++++++++++++++ docs/sources/administration/_index.md | 6 - .../enterprise-licensing/_index.md | 4 - .../organization-management/index.md | 4 - .../administration/provisioning/index.md | 4 - .../administration/recorded-queries/index.md | 4 - .../access-control/_index.md | 5 - .../administration/stats-and-license/index.md | 4 - docs/sources/alerting/_index.md | 5 - docs/sources/breaking-changes/_index.md | 5 - docs/sources/dashboards/_index.md | 6 - docs/sources/datasources/_index.md | 6 - docs/sources/explore/_index.md | 6 - docs/sources/fundamentals/_index.md | 6 - docs/sources/introduction/grafana-cloud.md | 3 - .../introduction/grafana-enterprise.md | 3 - docs/sources/panels-visualizations/_index.md | 6 - docs/sources/release-notes/_index.md | 6 - docs/sources/search/_index.md | 8 - .../configure-security/audit-grafana.md | 4 - .../configure-authentication/_index.md | 6 - .../configure-request-security.md | 5 - .../configure-security/configure-team-sync.md | 4 - .../configure-security/export-logs.md | 4 - docs/sources/troubleshooting/_index.md | 6 - docs/sources/whatsnew/_index.md | 5 - 26 files changed, 193 insertions(+), 125 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index b4ab84c7aa7..c3878932142 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -3,6 +3,199 @@ aliases: - /docs/grafana/v1.1/ - /docs/grafana/v3.1/ - guides/reference/admin/ +cascade: + # Until a better mechanism for arrangement is thought of, the following sequence should be ordered alphabetically by the `_target.path` value. + - _target: { path: /docs/grafana/** } # Default to every page having "Enterprise" and "Open source" labels. + labels: + products: + - enterprise + - oss + + - _target: { path: /docs/grafana/** } + labels: + products: + - enterprise + - oss + + - _target: { path: /docs/grafana/*/administration/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/administration/enterprise-licensing/** } + labels: + products: + - enterprise + + - _target: { path: /docs/grafana/*/administration/organization-management/** } + labels: + products: + - enterprise + - oss + + - _target: { path: /docs/grafana/*/administration/provisioning/** } + labels: + products: + - enterprise + - oss + + - _target: { path: /docs/grafana/*/administration/recorded-queries/** } + labels: + products: + - cloud + - enterprise + + - _target: { path: /docs/grafana/*/administration/roles-and-permissions/access-control/** } + labels: + products: + - cloud + - enterprise + + - _target: { path: /docs/grafana/*/administration/stats-and-license/** } + labels: + products: + - enterprise + - oss + + - _target: { path: /docs/grafana/*/alerting/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/breaking-changes/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/dashboards/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/datasources/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/explore/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/fundamentals/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/introduction/grafana-cloud/** } + labels: + products: + - cloud + + - _target: { path: /docs/grafana/*/introduction/grafana-enterprise/** } + labels: + products: + - enterprise + + - _target: { path: /docs/grafana/*/panels-visualizations/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/release-notes/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/search/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/setup-grafana/configure-security/audit-grafana/** } + labels: + products: + - cloud + - enterprise + + - _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-authentication/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-authentication/enhanced-ldap/** } + labels: + products: + - cloud + - enterprise + + - _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-authentication/saml/** } + labels: + products: + - cloud + - enterprise + + - _target: + path: /docs/grafana/*/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/** + labels: + products: + - cloud + - enterprise + + - _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-request-security/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-team-sync/** } + labels: + products: + - cloud + - enterprise + + - _target: { path: /docs/grafana/*/setup-grafana/configure-security/export-logs/** } + labels: + products: + - cloud + - oss + + - _target: { path: /docs/grafana/*/troubleshooting/** } + labels: + products: + - cloud + - enterprise + - oss + + - _target: { path: /docs/grafana/*/whatsnew/** } + labels: + products: + - cloud + - enterprise + - oss description: Guides, installation, and feature documentation keywords: - grafana diff --git a/docs/sources/administration/_index.md b/docs/sources/administration/_index.md index ef1699b2158..c9a8a8ea313 100644 --- a/docs/sources/administration/_index.md +++ b/docs/sources/administration/_index.md @@ -1,10 +1,4 @@ --- -cascade: - labels: - products: - - cloud - - enterprise - - oss description: Administration title: Administration weight: 40 diff --git a/docs/sources/administration/enterprise-licensing/_index.md b/docs/sources/administration/enterprise-licensing/_index.md index bee4a0d4f92..b8b071be7ef 100644 --- a/docs/sources/administration/enterprise-licensing/_index.md +++ b/docs/sources/administration/enterprise-licensing/_index.md @@ -8,10 +8,6 @@ aliases: - ../enterprise/license/license-expiration/ - ../enterprise/license/license-restrictions/ - license-restrictions/ -cascade: - labels: - products: - - enterprise description: Activate and manage a Grafana Enterprise license keywords: - grafana diff --git a/docs/sources/administration/organization-management/index.md b/docs/sources/administration/organization-management/index.md index 0d93b93e5d6..b181824de55 100644 --- a/docs/sources/administration/organization-management/index.md +++ b/docs/sources/administration/organization-management/index.md @@ -8,10 +8,6 @@ description: Describes how to use organizations to isolate dashboard to users an keywords: - organizations - dashboards -labels: - products: - - enterprise - - oss menuTitle: Manage organizations title: Manage organizations weight: 200 diff --git a/docs/sources/administration/provisioning/index.md b/docs/sources/administration/provisioning/index.md index ac2499965fb..c4c47c2fb8b 100644 --- a/docs/sources/administration/provisioning/index.md +++ b/docs/sources/administration/provisioning/index.md @@ -5,10 +5,6 @@ description: Describes provisioning settings for Grafana using configuration fil keywords: - grafana - provisioning -labels: - products: - - enterprise - - oss title: Provision Grafana weight: 600 --- diff --git a/docs/sources/administration/recorded-queries/index.md b/docs/sources/administration/recorded-queries/index.md index 8851049d1cf..d425d11ccfc 100644 --- a/docs/sources/administration/recorded-queries/index.md +++ b/docs/sources/administration/recorded-queries/index.md @@ -7,10 +7,6 @@ keywords: - query - queries - recorded -labels: - products: - - cloud - - enterprise title: Recorded queries weight: 300 --- diff --git a/docs/sources/administration/roles-and-permissions/access-control/_index.md b/docs/sources/administration/roles-and-permissions/access-control/_index.md index 113e82ca469..57434bdf128 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/_index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/_index.md @@ -3,11 +3,6 @@ aliases: - ../../enterprise/access-control/ - ../../enterprise/access-control/about-rbac/ - ../../enterprise/access-control/roles/ -cascade: - labels: - products: - - cloud - - enterprise description: Role-based access control (RBAC) provides a standardized way of granting, changing, and revoking access so that users can view and modify Grafana resources, such as users and reports. diff --git a/docs/sources/administration/stats-and-license/index.md b/docs/sources/administration/stats-and-license/index.md index a2bf04b398c..bc392180887 100644 --- a/docs/sources/administration/stats-and-license/index.md +++ b/docs/sources/administration/stats-and-license/index.md @@ -11,10 +11,6 @@ keywords: - configuration - server - settings -labels: - products: - - enterprise - - oss title: View server statistics and license weight: 400 --- diff --git a/docs/sources/alerting/_index.md b/docs/sources/alerting/_index.md index f5aa464f53f..21515baf730 100644 --- a/docs/sources/alerting/_index.md +++ b/docs/sources/alerting/_index.md @@ -3,11 +3,6 @@ aliases: - about-alerting/ - unified-alerting/alerting/ description: Intro to key benefits and features of Grafana Alerting -cascade: - labels: - products: - - cloud - - oss title: Alerting weight: 114 --- diff --git a/docs/sources/breaking-changes/_index.md b/docs/sources/breaking-changes/_index.md index 02f34df2d94..02b36c1a031 100644 --- a/docs/sources/breaking-changes/_index.md +++ b/docs/sources/breaking-changes/_index.md @@ -1,11 +1,6 @@ --- aliases: - guides/ -cascade: - labels: - products: - - cloud - - oss title: Breaking changes weight: 2 --- diff --git a/docs/sources/dashboards/_index.md b/docs/sources/dashboards/_index.md index 11c1d5055d5..c548e42e61c 100644 --- a/docs/sources/dashboards/_index.md +++ b/docs/sources/dashboards/_index.md @@ -1,12 +1,6 @@ --- aliases: - features/dashboard/dashboards/ -cascade: - labels: - products: - - cloud - - enterprise - - oss title: Dashboards weight: 70 --- diff --git a/docs/sources/datasources/_index.md b/docs/sources/datasources/_index.md index 75fedbcf086..42a064765ae 100644 --- a/docs/sources/datasources/_index.md +++ b/docs/sources/datasources/_index.md @@ -2,12 +2,6 @@ aliases: - data-sources/ - overview/ -cascade: - labels: - products: - - cloud - - enterprise - - oss title: Data sources weight: 60 --- diff --git a/docs/sources/explore/_index.md b/docs/sources/explore/_index.md index fc24f9c6407..f723b0f028d 100644 --- a/docs/sources/explore/_index.md +++ b/docs/sources/explore/_index.md @@ -1,12 +1,6 @@ --- aliases: - features/explore/ -cascade: - labels: - products: - - cloud - - enterprise - - oss keywords: - explore - loki diff --git a/docs/sources/fundamentals/_index.md b/docs/sources/fundamentals/_index.md index 8469eecda6d..1452af2704b 100644 --- a/docs/sources/fundamentals/_index.md +++ b/docs/sources/fundamentals/_index.md @@ -1,12 +1,6 @@ --- aliases: - basics/ -cascade: - labels: - products: - - cloud - - enterprise - - oss title: Fundamentals description: Learn about the basics of observability. weight: 8 diff --git a/docs/sources/introduction/grafana-cloud.md b/docs/sources/introduction/grafana-cloud.md index bf5ec2ebeba..ef277565361 100644 --- a/docs/sources/introduction/grafana-cloud.md +++ b/docs/sources/introduction/grafana-cloud.md @@ -1,7 +1,4 @@ --- -labels: - products: - - cloud title: Grafana Cloud description: Learn about Grafana Cloud. weight: 300 diff --git a/docs/sources/introduction/grafana-enterprise.md b/docs/sources/introduction/grafana-enterprise.md index 0d1b914ace4..49f5cc77355 100644 --- a/docs/sources/introduction/grafana-enterprise.md +++ b/docs/sources/introduction/grafana-enterprise.md @@ -1,9 +1,6 @@ --- aliases: - ../enterprise/ -labels: - products: - - enterprise description: Grafana Enterprise overview title: Grafana Enterprise weight: 200 diff --git a/docs/sources/panels-visualizations/_index.md b/docs/sources/panels-visualizations/_index.md index a0097eabbc4..d5f6742c79a 100644 --- a/docs/sources/panels-visualizations/_index.md +++ b/docs/sources/panels-visualizations/_index.md @@ -3,12 +3,6 @@ aliases: - dashboards/configure-panels-visualizations/ - features/panels/panels/ - panels/ -cascade: - labels: - products: - - cloud - - enterprise - - oss keywords: - grafana - configure diff --git a/docs/sources/release-notes/_index.md b/docs/sources/release-notes/_index.md index b46b559c092..9873fef84c3 100644 --- a/docs/sources/release-notes/_index.md +++ b/docs/sources/release-notes/_index.md @@ -1,10 +1,4 @@ --- -cascade: - labels: - products: - - cloud - - enterprise - - oss title: Release notes weight: 10000 --- diff --git a/docs/sources/search/_index.md b/docs/sources/search/_index.md index bc1730dc456..fc49ec14037 100644 --- a/docs/sources/search/_index.md +++ b/docs/sources/search/_index.md @@ -1,12 +1,4 @@ --- -aliases: - - ./ -cascade: - labels: - products: - - cloud - - enterprise - - oss description: Learn how to search for Grafana dashboards keywords: - search diff --git a/docs/sources/setup-grafana/configure-security/audit-grafana.md b/docs/sources/setup-grafana/configure-security/audit-grafana.md index 15e9617df72..8ec846dddc7 100644 --- a/docs/sources/setup-grafana/configure-security/audit-grafana.md +++ b/docs/sources/setup-grafana/configure-security/audit-grafana.md @@ -7,10 +7,6 @@ keywords: - auditing - audit - logs -labels: - products: - - cloud - - enterprise title: Audit a Grafana instance weight: 800 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md index ba0b7e8a7b5..7e3de5c0025 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md @@ -2,12 +2,6 @@ aliases: - ../../auth/ - ../../auth/overview/ -cascade: - labels: - products: - - cloud - - enterprise - - oss description: Learn about all the ways in which you can configure Grafana to authenticate users. labels: diff --git a/docs/sources/setup-grafana/configure-security/configure-request-security.md b/docs/sources/setup-grafana/configure-security/configure-request-security.md index 9a2fb05cb9a..0c89800684c 100644 --- a/docs/sources/setup-grafana/configure-security/configure-request-security.md +++ b/docs/sources/setup-grafana/configure-security/configure-request-security.md @@ -4,11 +4,6 @@ aliases: description: Request security enables you to limit requests from the Grafana server by targeting requests generated by users, such as data source metric queries and alert notifications. -labels: - products: - - cloud - - enterprise - - oss title: Configure request security weight: 1100 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-team-sync.md b/docs/sources/setup-grafana/configure-security/configure-team-sync.md index 8bac496aea6..6660fd547f5 100644 --- a/docs/sources/setup-grafana/configure-security/configure-team-sync.md +++ b/docs/sources/setup-grafana/configure-security/configure-team-sync.md @@ -4,10 +4,6 @@ aliases: - ../../enterprise/team-sync/ description: Learn how to use Team Sync to synchronize between your authentication provider teams and Grafana teams. -labels: - products: - - cloud - - enterprise title: Configure Team Sync weight: 1000 --- diff --git a/docs/sources/setup-grafana/configure-security/export-logs.md b/docs/sources/setup-grafana/configure-security/export-logs.md index f723c5d7dfb..aac698c9904 100644 --- a/docs/sources/setup-grafana/configure-security/export-logs.md +++ b/docs/sources/setup-grafana/configure-security/export-logs.md @@ -7,10 +7,6 @@ keywords: - export - usage-insights - enterprise -labels: - products: - - cloud - - oss title: Export logs of usage insights weight: 900 --- diff --git a/docs/sources/troubleshooting/_index.md b/docs/sources/troubleshooting/_index.md index 40cffd947e4..9be38be4b03 100644 --- a/docs/sources/troubleshooting/_index.md +++ b/docs/sources/troubleshooting/_index.md @@ -1,12 +1,6 @@ --- aliases: - troubleshoot-dashboards/ -cascade: - labels: - products: - - cloud - - enterprise - - oss description: Guide to troubleshooting Grafana problems keywords: - grafana diff --git a/docs/sources/whatsnew/_index.md b/docs/sources/whatsnew/_index.md index 5a9f903138a..3e49383dac3 100644 --- a/docs/sources/whatsnew/_index.md +++ b/docs/sources/whatsnew/_index.md @@ -53,11 +53,6 @@ aliases: - whats-new-in-v6-5/ - whats-new-in-v6-6/ - whats-new-in-v6-7/ -cascade: - labels: - products: - - cloud - - oss menuTitle: What's new title: What's new in Grafana weight: 1