From 281465c4211aabab2fe2597a0c53404ec2b5d4e9 Mon Sep 17 00:00:00 2001 From: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Date: Thu, 19 Nov 2020 10:37:18 -0500 Subject: [PATCH] =?UTF-8?q?Getting=20Started:=20Updated=20index=20topic,?= =?UTF-8?q?=20removed=20"what-is-grafana",=20and=20adjusted=20weight=20o?= =?UTF-8?q?=E2=80=A6=20(#29216)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Updated index topic, removed "what-is-grafana", and adjusted weight of few other topics. Also, updated the left menu. * Updated title to "Getting started". * Added alias /docs/grafana/latest/guides/what-is-grafana to _index.md file --- docs/sources/_index.md | 4 - docs/sources/getting-started/_index.md | 85 +++++++++++++++++- .../getting-started-prometheus.md | 2 +- .../getting-started/getting-started.md | 4 +- docs/sources/getting-started/glossary.md | 2 +- .../getting-started/intro-histograms.md | 2 +- .../getting-started/timeseries-dimensions.md | 2 +- docs/sources/getting-started/timeseries.md | 2 +- .../getting-started/what-is-grafana.md | 89 ------------------- docs/sources/menu.yaml | 2 - 10 files changed, 90 insertions(+), 104 deletions(-) delete mode 100644 docs/sources/getting-started/what-is-grafana.md diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 072d6814544..02fa8af5878 100755 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -44,10 +44,6 @@ aliases = ["/docs/grafana/v1.1", "/docs/grafana/latest/guides/reference/admin", ## Guides
- }}" class="nav-cards__item nav-cards__item--guide"> -

What is Grafana?

-

Get an overview of Grafana's key features.

- }}" class="nav-cards__item nav-cards__item--guide">

Getting started

Learn the basics of using Grafana.

diff --git a/docs/sources/getting-started/_index.md b/docs/sources/getting-started/_index.md index 2a9a53bc557..bec11b6931d 100644 --- a/docs/sources/getting-started/_index.md +++ b/docs/sources/getting-started/_index.md @@ -1,8 +1,89 @@ +++ -title = "Getting started" +title = "Getting Started" weight = 10 +aliases = ["/docs/grafana/latest/guides/what-is-grafana"] +++ # Getting started -This section will help first time users get acquainted with Grafana. Grafana is an open source platform for monitoring and observability. To learn more, refer to [What is Grafana?]({{< relref "what-is-grafana.md" >}}). +This section provides a high-level look at Grafana, the Grafana process, and Grafana features. It's a good place to learn how to use the Grafana software. + +## What is Grafana? + +Grafana is open source visualization and analytics software. It allows you to query, visualize, alert on, and explore your metrics no matter where they are stored. In plain English, it provides you with tools to turn your time-series database (TSDB) data into beautiful graphs and visualizations. + +After creating a dashboard like you do in [Getting started]({{< relref "getting-started.md" >}}), there are many possible things you might do next. It all depends on your needs and your use case. + +For example, if you want to view weather data and statistics about your smart home, then you might create a playlist. If you are the administrator for a corporation and are managing Grafana for multiple teams, then you might need to set up provisioning and authentication. + +The following sections provide an overview of things you might want to do with your Grafana database and links so you can learn more. For more guidance and ideas, check out the [Grafana Community forums](https://community.grafana.com/). + +## Explore metrics and logs + +Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side. + +Refer to [Explore]({{< relref "../explore/index.md" >}}) for more information. + +## Alerts + +If you're using Grafana alerting, then you can have alerts sent through a number of different [alert notifiers]({{< relref "../alerting/notifications.md" >}}), including PagerDuty, SMS, email, VictorOps, OpsGenie, or Slack. + +Alert hooks allow you to create different notifiers with a bit of code if you prefer some other channels of communication. Visually define [alert rules]({{< relref "../alerting/alerts-overview.md" >}}) for your most important metrics. + +## Annotations + +Annotate graphs with rich events from different data sources. Hover over events to see the full event metadata and tags. + +This feature, which shows up as a graph marker in Grafana, is useful for correlating data in case something goes wrong. You can create the annotations manually—just control-click on a graph and input some text—or you can fetch data from any data source. + +Refer to [Annotations]({{< relref "../dashboards/annotations.md" >}}) for more information. + +## Dashboard variables + +[Template variables]({{< relref "../variables/_index.md" >}}) allow you to create dashboards that can be reused for lots of different use cases. Values aren't hard-coded with these templates, so for instance, if you have a production server and a test server, you can use the same dashboard for both. + +Templating allows you to drill down into your data, say, from all data to North America data, down to Texas data, and beyond. You can also share these dashboards across teams within your organization—or if you create a great dashboard template for a popular data source, you can contribute it to the whole community to customize and use. + +## Configure Grafana + +If you're a Grafana administrator, then you'll want to thoroughly familiarize yourself with [Grafana configuration options]({{< relref "../administration/configuration.md" >}}) and the [Grafana CLI]({{< relref "../administration/cli.md" >}}). + +Configuration covers both config files and environment variables. You can set up default ports, logging levels, email IP addresses, security, and more. + +## Import dashboards and plugins + +Discover hundreds of [dashboards](https://grafana.com/grafana/dashboards) and [plugins](https://grafana.com/grafana/plugins) in the official library. Thanks to the passion and momentum of community members, new ones are added every week. + +## Authentication + +Grafana supports different authentication methods, such as LDAP and OAuth, and allows you to map users to organizations. Refer to the [User authentication overview]({{< relref "../auth/overview.md" >}}) for more information. + +In Grafana Enterprise, you can also map users to teams: If your company has its own authentication system, Grafana allows you to map the teams in your internal systems to teams in Grafana. That way, you can automatically give people access to the dashboards designated for their teams. + +Refer to [Grafana Enterprise]({{< relref "../enterprise/_index.md" >}}) for more information. + +## Provisioning + +While it's easy to click, drag, and drop to create a single dashboard, power users in need of many dashboards will want to automate the setup with a script. You can script anything in Grafana. + +For example, if you're spinning up a new Kubernetes cluster, you can also spin up a Grafana automatically with a script that would have the right server, IP address, and data sources preset and locked in so users cannot change them. It's also a way of getting control over a lot of dashboards. + +Refer to [Provisioning]({{< relref "../administration/provisioning.md" >}}) for more information. + +## Permissions + +When organizations have one Grafana and multiple teams, they often want the ability to both keep things separate and share dashboards. You can create a team of users and then set [permissions]({{< relref "../permissions/_index.md" >}}) on folders, dashboards, and down to the [data source level]({{< relref "../enterprise/datasource_permissions.md" >}}) if you're using [Grafana Enterprise]({{< relref "../enterprise/_index.md" >}}). + +## Grafana Cloud + +Grafana Cloud is a highly available, fast, fully managed OpenSaaS logging and metrics platform. Everything you love about Grafana, but Grafana Labs hosts it for you and handles all the headaches. + +[Learn more about Grafana Cloud.](https://grafana.com/cloud/) + +## Grafana Enterprise + +[Grafana Enterprise]({{< relref "../enterprise/_index.md" >}}) is a commercial edition of Grafana that includes additional features not found in the open source version. + +Building on everything you already know and love about Grafana, Grafana Enterprise adds enterprise data sources, advanced authentication options, more permission controls, 24x7x365 support, and training from the core Grafana team. + +[Learn more about Grafana Enterprise](https://grafana.com/enterprise). To purchase Enterprise or obtain a trial license, contact the Grafana Labs [Sales Team](https://grafana.com/contact?about=support&topic=Grafana%20Enterprise). diff --git a/docs/sources/getting-started/getting-started-prometheus.md b/docs/sources/getting-started/getting-started-prometheus.md index 7fa80e87ea6..fac30365242 100644 --- a/docs/sources/getting-started/getting-started-prometheus.md +++ b/docs/sources/getting-started/getting-started-prometheus.md @@ -1,5 +1,5 @@ +++ -title = "Getting started with Grafana and Prometheus" +title = "With Grafana and Prometheus" description = "Guide for getting started with Grafana" keywords = ["grafana", "intro", "guide", "started"] aliases = ["/docs/grafana/latest/guides/gettingstarted","/docs/grafana/latest/guides/getting_started"] diff --git a/docs/sources/getting-started/getting-started.md b/docs/sources/getting-started/getting-started.md index 87f5a46d24a..93b9084eb21 100644 --- a/docs/sources/getting-started/getting-started.md +++ b/docs/sources/getting-started/getting-started.md @@ -1,5 +1,5 @@ +++ -title = "Getting started with Grafana" +title = "With Grafana" description = "Guide for getting started with Grafana" keywords = ["grafana", "intro", "guide", "started"] aliases = ["/docs/grafana/latest/guides/gettingstarted","/docs/grafana/latest/guides/getting_started"] @@ -8,7 +8,7 @@ weight = 200 # Getting started with Grafana -This topic helps you get started with Grafana and build your first dashboard. To learn more about Grafana, refer to [What is Grafana?]({{< relref "what-is-grafana.md" >}}). +This topic helps you get started with Grafana and build your first dashboard. To learn more about Grafana, refer to [What is Grafana?]({{< relref "_index.md" >}}). ## Step 1: Install Grafana diff --git a/docs/sources/getting-started/glossary.md b/docs/sources/getting-started/glossary.md index 27bc750dc33..f5d0e40bb40 100644 --- a/docs/sources/getting-started/glossary.md +++ b/docs/sources/getting-started/glossary.md @@ -3,7 +3,7 @@ title = "Glossary" description = "Grafana glossary" keywords = ["grafana", "intro", "glossary", "dictionary"] aliases = ["/docs/grafana/latest/guides/glossary"] -weight = 500 +weight = 700 +++ # Glossary diff --git a/docs/sources/getting-started/intro-histograms.md b/docs/sources/getting-started/intro-histograms.md index c48bb243506..f71d296fa5f 100644 --- a/docs/sources/getting-started/intro-histograms.md +++ b/docs/sources/getting-started/intro-histograms.md @@ -2,7 +2,7 @@ title = "Histograms and heatmaps" description = "An introduction to histograms and heatmaps" keywords = ["grafana", "heatmap", "panel", "documentation", "histogram"] -weight = 400 +weight = 600 +++ # Introduction to histograms and heatmaps diff --git a/docs/sources/getting-started/timeseries-dimensions.md b/docs/sources/getting-started/timeseries-dimensions.md index fc391484372..8c3f0024bfd 100644 --- a/docs/sources/getting-started/timeseries-dimensions.md +++ b/docs/sources/getting-started/timeseries-dimensions.md @@ -3,7 +3,7 @@ title = "Time series dimensions" description = "time series dimensions" keywords = ["grafana", "intro", "guide", "concepts", "timeseries", "labels"] aliases = ["/docs/grafana/latest/guides/timeseries-dimensions"] -weight = 300 +weight = 500 +++ # Time series dimensions diff --git a/docs/sources/getting-started/timeseries.md b/docs/sources/getting-started/timeseries.md index c5cd174908c..85a723910e8 100644 --- a/docs/sources/getting-started/timeseries.md +++ b/docs/sources/getting-started/timeseries.md @@ -3,7 +3,7 @@ title = "Time series" description = "Introduction to time series" keywords = ["grafana", "intro", "guide", "concepts", "timeseries"] aliases = ["/docs/grafana/latest/guides/timeseries"] -weight = 300 +weight = 400 +++ # Introduction to time series diff --git a/docs/sources/getting-started/what-is-grafana.md b/docs/sources/getting-started/what-is-grafana.md deleted file mode 100644 index f9e52903d41..00000000000 --- a/docs/sources/getting-started/what-is-grafana.md +++ /dev/null @@ -1,89 +0,0 @@ -+++ -title = "What is Grafana?" -description = "Overview of Grafana and features" -keywords = ["grafana", "intro", "guide", "started"] -aliases = ["/docs/grafana/latest/guides/what-is-grafana"] -weight = 200 -+++ - -# What is Grafana? - -This topic provides a high-level look at Grafana, the Grafana process, and Grafana features. It's a good place to start if you want to learn more about Grafana software. To jump right in, refer to [Getting started]({{< relref "getting-started.md" >}}). - -Grafana is open source visualization and analytics software. It allows you to query, visualize, alert on, and explore your metrics no matter where they are stored. In plain English, it provides you with tools to turn your time-series database (TSDB) data into beautiful graphs and visualizations. - -After creating a dashboard like you do in [Getting started]({{< relref "getting-started.md" >}}), there are many possible things you might do next. It all depends on your needs and your use case. - -For example, if you want to view weather data and statistics about your smart home, then you might create a playlist. If you are the administrator for a corporation and are managing Grafana for multiple teams, then you might need to set up provisioning and authentication. - -The following sections provide an overview of things you might want to do with your Grafana database and links so you can learn more. For more guidance and ideas, check out the [Grafana Community forums](https://community.grafana.com/). - -## Explore metrics and logs - -Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side. - -Refer to [Explore]({{< relref "../explore/index.md" >}}) for more information. - -## Alerts - -If you're using Grafana alerting, then you can have alerts sent through a number of different [alert notifiers]({{< relref "../alerting/notifications.md" >}}), including PagerDuty, SMS, email, VictorOps, OpsGenie, or Slack. - -Alert hooks allow you to create different notifiers with a bit of code if you prefer some other channels of communication. Visually define [alert rules]({{< relref "../alerting/alerts-overview.md" >}}) for your most important metrics. - -## Annotations - -Annotate graphs with rich events from different data sources. Hover over events to see the full event metadata and tags. - -This feature, which shows up as a graph marker in Grafana, is useful for correlating data in case something goes wrong. You can create the annotations manually—just control-click on a graph and input some text—or you can fetch data from any data source. - -Refer to [Annotations]({{< relref "../dashboards/annotations.md" >}}) for more information. - -## Dashboard variables - -[Template variables]({{< relref "../variables/_index.md" >}}) allow you to create dashboards that can be reused for lots of different use cases. Values aren't hard-coded with these templates, so for instance, if you have a production server and a test server, you can use the same dashboard for both. - -Templating allows you to drill down into your data, say, from all data to North America data, down to Texas data, and beyond. You can also share these dashboards across teams within your organization—or if you create a great dashboard template for a popular data source, you can contribute it to the whole community to customize and use. - -## Configure Grafana - -If you're a Grafana administrator, then you'll want to thoroughly familiarize yourself with [Grafana configuration options]({{< relref "../administration/configuration.md" >}}) and the [Grafana CLI]({{< relref "../administration/cli.md" >}}). - -Configuration covers both config files and environment variables. You can set up default ports, logging levels, email IP addresses, security, and more. - -## Import dashboards and plugins - -Discover hundreds of [dashboards](https://grafana.com/grafana/dashboards) and [plugins](https://grafana.com/grafana/plugins) in the official library. Thanks to the passion and momentum of community members, new ones are added every week. - -## Authentication - -Grafana supports different authentication methods, such as LDAP and OAuth, and allows you to map users to organizations. Refer to the [User authentication overview]({{< relref "../auth/overview.md" >}}) for more information. - -In Grafana Enterprise, you can also map users to teams: If your company has its own authentication system, Grafana allows you to map the teams in your internal systems to teams in Grafana. That way, you can automatically give people access to the dashboards designated for their teams. - -Refer to [Grafana Enterprise]({{< relref "../enterprise/_index.md" >}}) for more information. - -## Provisioning - -While it's easy to click, drag, and drop to create a single dashboard, power users in need of many dashboards will want to automate the setup with a script. You can script anything in Grafana. - -For example, if you're spinning up a new Kubernetes cluster, you can also spin up a Grafana automatically with a script that would have the right server, IP address, and data sources preset and locked in so users cannot change them. It's also a way of getting control over a lot of dashboards. - -Refer to [Provisioning]({{< relref "../administration/provisioning.md" >}}) for more information. - -## Permissions - -When organizations have one Grafana and multiple teams, they often want the ability to both keep things separate and share dashboards. You can create a team of users and then set [permissions]({{< relref "../permissions/_index.md" >}}) on folders, dashboards, and down to the [data source level]({{< relref "../enterprise/datasource_permissions.md" >}}) if you're using [Grafana Enterprise]({{< relref "../enterprise/_index.md" >}}). - -## Grafana Cloud - -Grafana Cloud is a highly available, fast, fully managed OpenSaaS logging and metrics platform. Everything you love about Grafana, but Grafana Labs hosts it for you and handles all the headaches. - -[Learn more about Grafana Cloud.](https://grafana.com/cloud/) - -## Grafana Enterprise - -[Grafana Enterprise]({{< relref "../enterprise/_index.md" >}}) is a commercial edition of Grafana that includes additional features not found in the open source version. - -Building on everything you already know and love about Grafana, Grafana Enterprise adds enterprise data sources, advanced authentication options, more permission controls, 24x7x365 support, and training from the core Grafana team. - -[Learn more about Grafana Enterprise](https://grafana.com/enterprise). To purchase Enterprise or obtain a trial license, contact the Grafana Labs [Sales Team](https://grafana.com/contact?about=support&topic=Grafana%20Enterprise). diff --git a/docs/sources/menu.yaml b/docs/sources/menu.yaml index 8ca4bd0f461..6580a26bf12 100644 --- a/docs/sources/menu.yaml +++ b/docs/sources/menu.yaml @@ -1,8 +1,6 @@ - name: Getting started link: /getting-started/ children: - - name: What is Grafana? - link: /getting-started/what-is-grafana/ - name: With Grafana link: /getting-started/getting-started/ - name: With Grafana and Prometheus