Skip to content

Commit

Permalink
Move 'Getting started' to 'Tasks' (grafana#6043)
Browse files Browse the repository at this point in the history
* Move 'Getting started' to 'Tasks'

* fix aliases
  • Loading branch information
thampiotr authored and BarunKGP committed Feb 20, 2024
1 parent 2266859 commit 07c69aa
Show file tree
Hide file tree
Showing 18 changed files with 114 additions and 56 deletions.
12 changes: 6 additions & 6 deletions docs/sources/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ Grafana Agent is available in three different variants:
[Static mode Kubernetes operator]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/operator"
[Flow mode]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow"
[Flow mode]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow"
[Prometheus]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/collect-prometheus-metrics.md"
[Prometheus]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/collect-prometheus-metrics.md"
[OTel]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/collect-opentelemetry-data.md"
[OTel]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/collect-opentelemetry-data.md"
[Loki]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/migrating-from-promtail.md"
[Loki]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/migrating-from-promtail.md"
[Prometheus]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/collect-prometheus-metrics.md"
[Prometheus]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/collect-prometheus-metrics.md"
[OTel]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/collect-opentelemetry-data.md"
[OTel]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/collect-opentelemetry-data.md"
[Loki]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/migrating-from-promtail.md"
[Loki]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/migrating-from-promtail.md"
[clustering]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/clustering/_index.md"
[clustering]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/clustering/_index.md"
[rules]: "/docs/agent/ -> /docs/agent/latest/flow/reference/components/mimir.rules.kubernetes.md"
Expand Down
File renamed without changes
File renamed without changes
6 changes: 3 additions & 3 deletions docs/sources/flow/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,14 +80,14 @@ This feature is experimental, and it doesn't support all River components.

* [Install][] {{< param "PRODUCT_NAME" >}}.
* Learn about the core [Concepts][] of {{< param "PRODUCT_NAME" >}}.
* Follow our [Getting started][] guides for {{< param "PRODUCT_NAME" >}}.
* Follow our [Tutorials][] to get started with {{< param "PRODUCT_NAME" >}}.
* Follow our [Tutorials][] for hands-on learning of {{< param "PRODUCT_NAME" >}}.
* Consult our [Tasks][] instructions to accomplish common objectives with {{< param "PRODUCT_NAME" >}}.
* Check out our [Reference][] documentation to find specific information you
might be looking for.

[Install]: {{< relref "./setup/install/" >}}
[Concepts]: {{< relref "./concepts/" >}}
[Getting started]: {{< relref "./getting-started/" >}}
[Tasks]: {{< relref "./tasks/" >}}
[Tutorials]: {{< relref "./tutorials/ ">}}
[Reference]: {{< relref "./reference" >}}

19 changes: 0 additions & 19 deletions docs/sources/flow/getting-started/_index.md

This file was deleted.

6 changes: 3 additions & 3 deletions docs/sources/flow/reference/cli/convert.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ This includes Prometheus features such as
and many supported *_sd_configs. Unsupported features in a source configuration result
in [errors].

Refer to [Migrate from Prometheus to {{< param "PRODUCT_NAME" >}}]({{< relref "../../getting-started/migrating-from-prometheus/" >}}) for a detailed migration guide.
Refer to [Migrate from Prometheus to {{< param "PRODUCT_NAME" >}}]({{< relref "../../tasks/migrating-from-prometheus/" >}}) for a detailed migration guide.

### Promtail

Expand All @@ -96,7 +96,7 @@ are supported and can be converted to {{< param "PRODUCT_NAME" >}} configuration
If you have unsupported features in a source configuration, you will receive [errors] when you convert to a flow configuration. The converter will
also raise warnings for configuration options that may require your attention.

Refer to [Migrate from Promtail to {{< param "PRODUCT_NAME" >}}]({{< relref "../../getting-started/migrating-from-promtail/" >}}) for a detailed migration guide.
Refer to [Migrate from Promtail to {{< param "PRODUCT_NAME" >}}]({{< relref "../../tasks/migrating-from-promtail/" >}}) for a detailed migration guide.

### Static

Expand All @@ -113,4 +113,4 @@ flags with a space between each flag, for example `--extra-args="-enable-feature
If you have unsupported features in a Static mode source configuration, you will receive [errors][] when you convert to a Flow mode configuration. The converter will
also raise warnings for configuration options that may require your attention.

Refer to [Migrate from Grafana Agent Static to {{< param "PRODUCT_NAME" >}}]({{< relref "../../getting-started/migrating-from-static/" >}}) for a detailed migration guide.
Refer to [Migrate from Grafana Agent Static to {{< param "PRODUCT_NAME" >}}]({{< relref "../../tasks/migrating-from-static/" >}}) for a detailed migration guide.
25 changes: 25 additions & 0 deletions docs/sources/flow/tasks/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/
- /docs/grafana-cloud/send-data/agent/flow/tasks/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/getting-started/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/
- getting_started/ # /docs/agent/latest/flow/getting_started/
- getting-started/ # /docs/agent/latest/flow/getting-started/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/
description: How to perform common tasks with Grafana Agent Flow
menuTitle: Tasks
title: Tasks with Grafana Agent Flow
weight: 200
---

# Tasks with {{% param "PRODUCT_NAME" %}}

This section details how to perform common tasks with {{< param "PRODUCT_NAME" >}}.

{{< section >}}
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/collect-opentelemetry-data/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/collect-opentelemetry-data/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/collect-opentelemetry-data/
- /docs/grafana-cloud/send-data/agent/flow/tasks/collect-opentelemetry-data/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/getting-started/collect-opentelemetry-data/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/collect-opentelemetry-data/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/collect-opentelemetry-data/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/collect-opentelemetry-data/
canonical: https://grafana.com/docs/agent/latest/flow/getting-started/collect-opentelemetry-data/
- ../getting-started/collect-opentelemetry-data/ # /docs/agent/latest/flow/getting-started/collect-opentelemetry-data/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/collect-opentelemetry-data/
description: Learn how to collect OpenTelemetry data
title: Collect OpenTelemetry data
weight: 300
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/collect-prometheus-metrics/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/collect-prometheus-metrics/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/collect-prometheus-metrics/
- /docs/grafana-cloud/send-data/agent/flow/tasks/collect-prometheus-metrics/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/getting-started/collect-prometheus-metrics/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/collect-prometheus-metrics/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/collect-prometheus-metrics/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/collect-prometheus-metrics/
canonical: https://grafana.com/docs/agent/latest/flow/getting-started/collect-prometheus-metrics/
- ../getting-started/collect-prometheus-metrics/ # /docs/agent/latest/flow/getting-started/collect-prometheus-metrics/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/collect-prometheus-metrics/
description: Learn how to collect and forward Prometheus metrics
title: Collect and forward Prometheus metrics
weight: 200
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/configure-agent-clustering/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/configure-agent-clustering/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/configure-agent-clustering/
- /docs/grafana-cloud/send-data/agent/flow/tasks/configure-agent-clustering/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/getting-started/configure-agent-clustering/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/configure-agent-clustering/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/configure-agent-clustering/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/configure-agent-clustering/
canonical: https://grafana.com/docs/agent/latest/flow/getting-started/configure-agent-clustering/
- ../getting-started/configure-agent-clustering/ # /docs/agent/latest/flow/getting-started/configure-agent-clustering/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/configure-agent-clustering/
description: Learn how to configure Grafana Agent clustering in an existing installation
menuTitle: Configure Grafana Agent clustering
title: Configure Grafana Agent clustering in an existing installation
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/distribute-prometheus-scrape-load/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/distribute-prometheus-scrape-load/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/distribute-prometheus-scrape-load/
- /docs/grafana-cloud/send-data/agent/flow/tasks/distribute-prometheus-scrape-load/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/getting-started/distribute-prometheus-scrape-load/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/distribute-prometheus-scrape-load/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/distribute-prometheus-scrape-load/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/distribute-prometheus-scrape-load/
canonical: https://grafana.com/docs/agent/latest/flow/getting-started/distribute-prometheus-scrape-load/
- ../getting-started/distribute-prometheus-scrape-load/ # /docs/agent/latest/flow/getting-started/distribute-prometheus-scrape-load/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/distribute-prometheus-scrape-load/
description: Learn how to distribute your Prometheus metrics scrape load
menuTitle: Distribute Prometheus metrics scrape load
title: Distribute Prometheus metrics scrape load
Expand Down Expand Up @@ -53,10 +59,10 @@ To distribute Prometheus metrics scrape load with clustering:
[beta]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/stability.md#beta"
[configure-grafana-agent]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/setup/configure"
[configure-grafana-agent]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/setup/configure"
[Configure Prometheus metrics collection]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/collect-prometheus-metrics.md"
[Configure Prometheus metrics collection]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/getting-started/collect-prometheus-metrics.md"
[Configure clustering]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/configure-agent-clustering.md"
[Configure clustering]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/getting-started/configure-agent-clustering.md"
[Configure Prometheus metrics collection]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/collect-prometheus-metrics.md"
[Configure Prometheus metrics collection]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/collect-prometheus-metrics.md"
[Configure clustering]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/configure-agent-clustering.md"
[Configure clustering]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/configure-agent-clustering.md"
[UI]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/monitoring/debugging.md#component-detail-page"
[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging.md#component-detail-page"
{{% /docs/reference %}}
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
---
aliases:
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrating-from-operator/
- /docs/grafana-cloud/send-data/agent/flow/tasks/migrating-from-operator/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/migrating-from-operator/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/migrating-from-operator/
canonical: https://grafana.com/docs/agent/latest/flow/getting-started/migrating-from-operator/
- ../getting-started/migrating-from-operator/ # /docs/agent/latest/flow/getting-started/migrating-from-operator/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/migrating-from-operator/
description: Migrating from Grafana Agent Operator to Grafana Agent Flow
menuTitle: Migrate from Operator
title: Migrating from Grafana Agent Operator to Grafana Agent Flow
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/migrating-from-prometheus/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrating-from-prometheus/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/migrating-from-prometheus/
- /docs/grafana-cloud/send-data/agent/flow/tasks/migrating-from-prometheus/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/getting-started/migrating-from-prometheus/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/migrating-from-prometheus/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/migrating-from-prometheus/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/migrating-from-prometheus/
canonical: https://grafana.com/docs/agent/latest/flow/getting-started/migrating-from-prometheus/
- ../getting-started/migrating-from-prometheus/ # /docs/agent/latest/flow/getting-started/migrating-from-prometheus/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/migrating-from-prometheus/
description: Learn how to migrate from Prometheus to Grafana Agent Flow
menuTitle: Migrate from Prometheus
title: Migrate from Prometheus to Grafana Agent Flow
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/migrating-from-promtail/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrating-from-promtail/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/migrating-from-promtail/
- /docs/grafana-cloud/send-data/agent/flow/tasks/migrating-from-promtail/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/getting-started/migrating-from-promtail/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/migrating-from-promtail/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/migrating-from-promtail/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/migrating-from-promtail/
canonical: https://grafana.com/docs/agent/latest/flow/getting-started/migrating-from-promtail/
- ../getting-started/migrating-from-promtail/ # /docs/agent/latest/flow/getting-started/migrating-from-promtail/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/migrating-from-promtail/
description: Learn how to migrate from Promtail to Grafana Agent Flow
menuTitle: Migrate from Promtail
title: Migrate from Promtail to Grafana Agent Flow
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/migrating-from-static/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrating-from-static/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/migrating-from-static/
- /docs/grafana-cloud/send-data/agent/flow/tasks/migrating-from-static/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/getting-started/migrating-from-static/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/migrating-from-static/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/migrating-from-static/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/migrating-from-static/
canonical: https://grafana.com/docs/agent/latest/flow/getting-started/migrating-from-static/
- ../getting-started/migrating-from-static/ # /docs/agent/latest/flow/getting-started/migrating-from-static/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/migrating-from-static/
description: Learn how to migrate your configuration from Grafana Agent Static to Grafana Agent Flow
menuTitle: Migrate from Static to Flow
title: Migrate Grafana Agent Static to Grafana Agent Flow
Expand Down Expand Up @@ -382,10 +388,10 @@ The following list is specific to the convert command and not {{< param "PRODUCT
[Agent Management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static/configuration/agent-management.md"
[env]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/stdlib/env.md"
[env]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/stdlib/env.md"
[Prometheus Limitations]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/migrating-from-prometheus.md#limitations"
[Prometheus Limitations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/getting-started/migrating-from-prometheus.md#limitations"
[Promtail Limitations]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/migrating-from-promtail.md#limitations"
[Promtail Limitations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/getting-started/migrating-from-promtail.md#limitations"
[Prometheus Limitations]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/migrating-from-prometheus.md#limitations"
[Prometheus Limitations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/migrating-from-prometheus.md#limitations"
[Promtail Limitations]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/migrating-from-promtail.md#limitations"
[Promtail Limitations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/migrating-from-promtail.md#limitations"
[Metrics]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/static/configuration/metrics-config.md"
[Metrics]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static/configuration/metrics-config.md"
[Logs]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/static/configuration/logs-config.md"
Expand Down
Loading

0 comments on commit 07c69aa

Please sign in to comment.