From 5481399c535bbf9dcd5ee55bb94bae36f6d35ca0 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Tue, 11 Jun 2024 14:36:14 +0200 Subject: [PATCH] Docs: landing page for OSS/Enterprise (#89030) * Docs: landing page for OSS/Enterprise * adds alt text for image in alerting * Update docs/sources/_index.md Co-authored-by: Jack Baldry * Update docs/sources/_index.md Co-authored-by: Jack Baldry * Update docs/sources/_index.md Co-authored-by: Jack Baldry * changes according to jacks feedback * more fixes * ran prettier * adds upgrade tile * adds better description --------- Co-authored-by: Jack Baldry --- docs/sources/_index.md | 185 +++++++----------- .../alert-rules/annotation-label.md | 2 +- 2 files changed, 67 insertions(+), 120 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 6ab6539cf70..f9bd01a6685 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -6,137 +6,84 @@ aliases: cascade: TEMPO_VERSION: latest PYROSCOPE_VERSION: latest -description: Guides, installation, and feature documentation +description: Find answers to your technical questions and learn how to use Grafana OSS and Enterprise products. keywords: - grafana - - installation + - get started - documentation labels: products: - enterprise - oss -title: Grafana documentation +menuTitle: Grafana documentation +title: Grafana OSS and Enterprise documentation +hero: + title: Grafana OSS and Enterprise documentation + level: 1 + width: 110 + image: /media/docs/grafana-cloud/infrastructure/grafanalogo.svg + height: 110 + description: Query, visualize, alert on, and explore your metrics, logs, and traces wherever they are stored. +cards: + title_class: pt-0 lh-1 + items: + - title: What's new + href: ./whatsnew/ + description: Browse release highlights, deprecations, and breaking changes in Grafana releases. + height: 24 + - title: Introduction + href: ./fundamentals/ + description: Learn about observability topics in general and some of the products included in Grafana. + height: 24 + - title: Set up + href: ./setup-grafana/ + description: Get up and running with Grafana. + height: 24 + - title: Data sources + href: ./datasources/ + description: Manage data sources and how to configure or query the built-in data sources. + height: 24 + - title: Dashboards + href: ./dashboards/ + description: Query, transform, visualize, and understand your data no matter where it’s stored. + height: 24 + - title: Panels and Visualizations + href: ./panels-visualizations/ + description: Easily collect, correlate, and visualize data to make informed decisions in real-time. + height: 24 + - title: Explore + href: ./explore/ + description: Explore your data using a query instead of creating a dashboard. + height: 24 + - title: Alerting + href: ./alerting/ + description: Learn about problems in your systems moments after they occur. + height: 24 + - title: Administration + href: ./administration/ + description: Perform administrative tasks such as configuring user management and roles and permissions. + height: 24 + - title: Troubleshooting + href: ./troubleshooting/ + description: Troubleshoot common Grafana issues. + height: 24 + - title: Upgrade + href: ./upgrade-guide/ + description: Upgrade Grafana to stay current with the latest fixes and enhancements. + height: 24 --- -# Grafana documentation +{{< docs/hero-simple key="hero" >}} -## Installing Grafana +--- -
- }}" class="nav-cards__item nav-cards__item--install"> -
-
-
Install on Linux
- - }}" class="nav-cards__item nav-cards__item--install"> -
-
-
Install on macOS
- - }}" class="nav-cards__item nav-cards__item--install"> -
-
-
Install on Windows
- - }}" class="nav-cards__item nav-cards__item--install"> - -
Run Docker image
- - }}" class="nav-cards__item nav-cards__item--install"> - -
Run on Kubernetes
- - -
-
-
Grafana Cloud
- - -
-
-
Nightly builds
- -
+## Overview -## Guides +_Grafana Open Source Software (OSS)_ enables you to query, visualize, alert on, and explore your metrics, logs, and traces wherever they're stored. Grafana OSS provides you with tools to turn your time-series database (TSDB) data into insightful graphs and visualizations. The Grafana OSS plugin framework also enables you to connect other data sources like NoSQL/SQL databases, ticketing tools like Jira or ServiceNow, and CI/CD tooling like GitLab. -
- }}" class="nav-cards__item nav-cards__item--guide"> -

Getting started

-

Learn the basics of using Grafana.

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

Grafana fundamentals

-

Learn basic observability.

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

Configure Grafana

-

Review the configuration and setup options.

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

Intro to time series

-

Learn about time series data.

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

Provisioning

-

Learn how to automate your Grafana configuration.

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

What's new in v11.0

-

Explore the features and enhancements in the latest release.

- +_Grafana Enterprise_ is a commercial edition of Grafana that includes exclusive data source plugins and additional features not found in the open source version. You also get 24x7x365 support and training from the core Grafana team. +To learn more about these features, refer to [Enterprise features](https://grafana.com/docs/grafana//introduction/grafana-enterprise/#enterprise-features-in-grafana-cloud). -
+## Learn -## Data source guides - -
- }}" class="nav-cards__item nav-cards__item--ds"> - -
Graphite
- - }}" class="nav-cards__item nav-cards__item--ds"> - -
Elasticsearch
- - }}" class="nav-cards__item nav-cards__item--ds"> - -
InfluxDB
- - }}" class="nav-cards__item nav-cards__item--ds"> - -
Prometheus
- - }}" class="nav-cards__item nav-cards__item--ds"> - -
Google Cloud Monitoring
- - }}" class="nav-cards__item nav-cards__item--ds"> - -
AWS CloudWatch
- - }}" class="nav-cards__item nav-cards__item--ds"> - -
Azure Monitor
- - }}" class="nav-cards__item nav-cards__item--ds"> - -
Loki
- - }}" class="nav-cards__item nav-cards__item--ds"> - -
MySQL
- - }}" class="nav-cards__item nav-cards__item--ds"> - -
Postgres
- - }}" class="nav-cards__item nav-cards__item--ds"> - -
Microsoft SQL Server
- - }}" class="nav-cards__item nav-cards__item--ds"> - -
OpenTSDB
- -
+{{< card-grid key="cards" type="simple" >}} diff --git a/docs/sources/alerting/fundamentals/alert-rules/annotation-label.md b/docs/sources/alerting/fundamentals/alert-rules/annotation-label.md index 0b98e58d3f4..ca46da11579 100644 --- a/docs/sources/alerting/fundamentals/alert-rules/annotation-label.md +++ b/docs/sources/alerting/fundamentals/alert-rules/annotation-label.md @@ -68,7 +68,7 @@ Examples of labels are `server=server1` or `team=backend`. Each alert rule can h For example, an alert instance might have the label set `{alertname="High CPU usage",server="server1"}` while another alert instance might have the label set `{alertname="High CPU usage",server="server2"}`. These are two separate alert instances because although their `alertname` labels are the same, their `server` labels are different. -{{< figure src="/static/img/docs/alerting/unified/multi-dimensional-alert.png" >}} +{{< figure alt="Image shows an example of an alert instance and its labels" src="/static/img/docs/alerting/unified/multi-dimensional-alert.png" >}} Labels are a fundamental component of alerting: