From bad3d7c2db7bb2bd18cee00b58fa8b4ae1743aea Mon Sep 17 00:00:00 2001 From: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Date: Mon, 5 May 2025 10:19:17 -0400 Subject: [PATCH] [DOC] Make Obs as Code docs public (#104843) Co-authored-by: Isabel Matwawana --- docs/sources/observability-as-code/_index.md | 5 ----- docs/sources/observability-as-code/grafana-cli/_index.md | 3 --- .../grafana-cli/grafanacli-workflows.md | 3 --- .../grafana-cli/install-grafana-cli.md | 3 --- .../grafana-cli/set-up-grafana-cli.md | 9 +++------ .../observability-as-code/provision-resources/_index.md | 2 +- .../provision-resources/file-path-setup.md | 9 --------- .../provision-resources/git-sync-setup.md | 9 --------- .../provision-resources/intro-git-sync.md | 9 --------- .../provision-resources/provisioned-dashboards.md | 9 --------- .../provision-resources/use-git-sync.md | 9 --------- 11 files changed, 4 insertions(+), 66 deletions(-) diff --git a/docs/sources/observability-as-code/_index.md b/docs/sources/observability-as-code/_index.md index 3f92ff84655..54c881a895d 100644 --- a/docs/sources/observability-as-code/_index.md +++ b/docs/sources/observability-as-code/_index.md @@ -1,9 +1,4 @@ --- -_build: - list: false -noindex: true -cascade: - noindex: true description: Overview of Observability as Code including description, key features, and explanation of benefits. keywords: - observability diff --git a/docs/sources/observability-as-code/grafana-cli/_index.md b/docs/sources/observability-as-code/grafana-cli/_index.md index 58f9d3edc3d..b106281ffc8 100644 --- a/docs/sources/observability-as-code/grafana-cli/_index.md +++ b/docs/sources/observability-as-code/grafana-cli/_index.md @@ -1,7 +1,4 @@ --- -_build: - list: false -noindex: true cascade: noindex: true description: Overview of Grafana CLI, a command line tool for managing Grafana resources as code. diff --git a/docs/sources/observability-as-code/grafana-cli/grafanacli-workflows.md b/docs/sources/observability-as-code/grafana-cli/grafanacli-workflows.md index 980c6a92b83..d85b5a3a671 100644 --- a/docs/sources/observability-as-code/grafana-cli/grafanacli-workflows.md +++ b/docs/sources/observability-as-code/grafana-cli/grafanacli-workflows.md @@ -1,7 +1,4 @@ --- -_build: - list: false -noindex: true cascade: noindex: true description: Learn more about the supported workflows and use cases for Grafana CLI diff --git a/docs/sources/observability-as-code/grafana-cli/install-grafana-cli.md b/docs/sources/observability-as-code/grafana-cli/install-grafana-cli.md index 3277090c21f..82ecb04719a 100644 --- a/docs/sources/observability-as-code/grafana-cli/install-grafana-cli.md +++ b/docs/sources/observability-as-code/grafana-cli/install-grafana-cli.md @@ -1,7 +1,4 @@ --- -_build: - list: false -noindex: true cascade: noindex: true description: Installation guide for Grafana CLI, a command line tool for managing Grafana Observability as Code diff --git a/docs/sources/observability-as-code/grafana-cli/set-up-grafana-cli.md b/docs/sources/observability-as-code/grafana-cli/set-up-grafana-cli.md index 8da1a45257d..011602aa48c 100644 --- a/docs/sources/observability-as-code/grafana-cli/set-up-grafana-cli.md +++ b/docs/sources/observability-as-code/grafana-cli/set-up-grafana-cli.md @@ -1,7 +1,4 @@ --- -_build: - list: false -noindex: true cascade: noindex: true description: Configuration guide for Grafana CLI, a command line tool for managing Grafana resources as code. @@ -80,11 +77,11 @@ In these examples, `default` and `staging` are the names of the contexts. Grafana CLI stores its configuration in a YAML file. The CLI determines the configuration file location in the following order: 1. If the `--config` flag is provided, the specified file is used. -2. If `$XDG_CONFIG_HOME` is set: +2. If `$XDG_CONFIG_HOME` is set: `$XDG_CONFIG_HOME/grafanactl/config.yaml` -3. If `$HOME` is set: +3. If `$HOME` is set: `$HOME/.config/grafanactl/config.yaml` -4. If `$XDG_CONFIG_DIRS` is set: +4. If `$XDG_CONFIG_DIRS` is set: `$XDG_CONFIG_DIRS/grafanactl/config.yaml` {{< admonition type="note" >}} diff --git a/docs/sources/observability-as-code/provision-resources/_index.md b/docs/sources/observability-as-code/provision-resources/_index.md index 65785d437df..3f916098fd9 100644 --- a/docs/sources/observability-as-code/provision-resources/_index.md +++ b/docs/sources/observability-as-code/provision-resources/_index.md @@ -12,7 +12,7 @@ labels: - enterprise - oss title: Provision resources and sync dashboards -weight: 100 +weight: 300 --- # Provision resources and sync dashboards diff --git a/docs/sources/observability-as-code/provision-resources/file-path-setup.md b/docs/sources/observability-as-code/provision-resources/file-path-setup.md index c559163ec35..15574e74a8b 100644 --- a/docs/sources/observability-as-code/provision-resources/file-path-setup.md +++ b/docs/sources/observability-as-code/provision-resources/file-path-setup.md @@ -19,15 +19,6 @@ weight: 200 Local file provisioning is an [experimental feature](https://grafana.com/docs/release-life-cycle/) introduced in Grafana v12 for open source and Enterprise editions. Engineering and on-call support is not available. Documentation is either limited or not provided outside of code comments. No SLA is provided. Enable the `provisioning` and `kubernetesDashboards` feature toggles in Grafana to use this feature. This feature isn't available in Grafana Cloud. {{< /admonition >}} -- [Provision resources and sync dashboards](/docs/grafana//observability-as-code/provision-resources/) - - [Git Sync](/docs/grafana//observability-as-code/provision-resources/intro-git-sync/) - - [Set up Git Sync](/docs/grafana//observability-as-code/provision-resources/git-sync-setup/) - - [Set up file provisioning](/docs/grafana//observability-as-code/provision-resources/file-path-setup/) - - [Work with provisioned dashboards](/docs/grafana//observability-as-code/provision-resources/provisioned-dashboards/) - - [Manage provisioned repositories with Git Sync](/docs/grafana//observability-as-code/provision-resources/use-git-sync/) - -
- File provisioning in Grafana lets you include resources, including folders and dashboard JSON files, that are stored in a local file system. This page explains how to set up local file provisioning. diff --git a/docs/sources/observability-as-code/provision-resources/git-sync-setup.md b/docs/sources/observability-as-code/provision-resources/git-sync-setup.md index 153604cc9d4..3f942a6bc9c 100644 --- a/docs/sources/observability-as-code/provision-resources/git-sync-setup.md +++ b/docs/sources/observability-as-code/provision-resources/git-sync-setup.md @@ -19,15 +19,6 @@ weight: 100 Git Sync is an [experimental feature](https://grafana.com/docs/release-life-cycle/) introduced in Grafana v12 for open source and Enterprise editions. Engineering and on-call support is not available. Documentation is either limited or not provided outside of code comments. No SLA is provided. Enable the `provisioning` and `kubernetesDashboards` feature toggles in Grafana to use this feature. Git Sync isn't available in Grafana Cloud. {{< /admonition >}} -- [Provision resources and sync dashboards](/docs/grafana//observability-as-code/provision-resources/) - - [Git Sync](/docs/grafana//observability-as-code/provision-resources/intro-git-sync/) - - [Set up Git Sync](/docs/grafana//observability-as-code/provision-resources/git-sync-setup/) - - [Set up file provisioning](/docs/grafana//observability-as-code/provision-resources/file-path-setup/) - - [Work with provisioned dashboards](/docs/grafana//observability-as-code/provision-resources/provisioned-dashboards/) - - [Manage provisioned repositories with Git Sync](/docs/grafana//observability-as-code/provision-resources/use-git-sync/) - -
- Git Sync lets you manage Grafana dashboards as code by storing dashboards JSON files and folders in a remote GitHub repository. Alternatively, you can configure a local file system instead of using GitHub. Refer to [Set up file provisioning](https://grafana.com/docs/grafana//observability-as-code/provision-resources/file-path-setup/) for information. diff --git a/docs/sources/observability-as-code/provision-resources/intro-git-sync.md b/docs/sources/observability-as-code/provision-resources/intro-git-sync.md index fadde370e2e..5829930d4f6 100644 --- a/docs/sources/observability-as-code/provision-resources/intro-git-sync.md +++ b/docs/sources/observability-as-code/provision-resources/intro-git-sync.md @@ -19,15 +19,6 @@ weight: 100 Git Sync is an [experimental feature](https://grafana.com/docs/release-life-cycle/) introduced in Grafana v12 for open source and Enterprise editions. Engineering and on-call support is not available. Documentation is either limited or not provided outside of code comments. No SLA is provided. Enable the `provisioning` and `kubernetesDashboards` feature toggles in Grafana to use this feature. Git Sync isn't available in Grafana Cloud. {{< /admonition >}} -- [Provision resources and sync dashboards](/docs/grafana//observability-as-code/provision-resources/) - - [Git Sync](/docs/grafana//observability-as-code/provision-resources/intro-git-sync/) - - [Set up Git Sync](/docs/grafana//observability-as-code/provision-resources/git-sync-setup/) - - [Set up file provisioning](/docs/grafana//observability-as-code/provision-resources/file-path-setup/) - - [Work with provisioned dashboards](/docs/grafana//observability-as-code/provision-resources/provisioned-dashboards/) - - [Manage provisioned repositories with Git Sync](/docs/grafana//observability-as-code/provision-resources/use-git-sync/) - -
- Using Git Sync, you can: - Introduce a review process for creating and modifying dashboards diff --git a/docs/sources/observability-as-code/provision-resources/provisioned-dashboards.md b/docs/sources/observability-as-code/provision-resources/provisioned-dashboards.md index 4be207050a5..c81963605ec 100644 --- a/docs/sources/observability-as-code/provision-resources/provisioned-dashboards.md +++ b/docs/sources/observability-as-code/provision-resources/provisioned-dashboards.md @@ -19,15 +19,6 @@ weight: 300 Git Sync and File path provisioning an [experimental feature](https://grafana.com/docs/release-life-cycle/) introduced in Grafana v12 for open source and Enterprise editions. Engineering and on-call support is not available. Documentation is either limited or not provided outside of code comments. No SLA is provided. Enable the `provisioning` and `kubernetesDashboards` feature toggles in Grafana. These features aren't available in Grafana Cloud. {{< /admonition >}} -- [Provision resources and sync dashboards](/docs/grafana//observability-as-code/provision-resources/) - - [Git Sync](/docs/grafana//observability-as-code/provision-resources/intro-git-sync/) - - [Set up Git Sync](/docs/grafana//observability-as-code/provision-resources/git-sync-setup/) - - [Set up file provisioning](/docs/grafana//observability-as-code/provision-resources/file-path-setup/) - - [Work with provisioned dashboards](/docs/grafana//observability-as-code/provision-resources/provisioned-dashboards/) - - [Manage provisioned repositories with Git Sync](/docs/grafana//observability-as-code/provision-resources/use-git-sync/) - -
- Using Provisioning, you can choose to store your dashboard JSON files in either GitHub repositories using Git Sync or a local file path. For more information, refer to the [Dashboards](https://grafana.com/docs/grafana//dashboards/) documentation. diff --git a/docs/sources/observability-as-code/provision-resources/use-git-sync.md b/docs/sources/observability-as-code/provision-resources/use-git-sync.md index d67bb94d6d2..3e6e3a9c3f7 100644 --- a/docs/sources/observability-as-code/provision-resources/use-git-sync.md +++ b/docs/sources/observability-as-code/provision-resources/use-git-sync.md @@ -18,15 +18,6 @@ weight: 400 # Manage provisioned repositories with Git Sync -- [Provision resources and sync dashboards](/docs/grafana//observability-as-code/provision-resources/) - - [Git Sync](/docs/grafana//observability-as-code/provision-resources/intro-git-sync/) - - [Set up Git Sync](/docs/grafana//observability-as-code/provision-resources/git-sync-setup/) - - [Set up file provisioning](/docs/grafana//observability-as-code/provision-resources/file-path-setup/) - - [Work with provisioned dashboards](/docs/grafana//observability-as-code/provision-resources/provisioned-dashboards/) - - [Manage provisioned repositories with Git Sync](/docs/grafana//observability-as-code/provision-resources/use-git-sync/) - -
- After you have set up Git Sync, you can synchronize dashboards and changes to existing dashboards to your configured GitHub repository. If you push a change in the repository, those changes are mirrored in your Grafana instance.