Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Rename 'Setup' to 'Get started' and 'Start' to 'Run' #6112

Merged
merged 4 commits into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/sources/flow/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ This feature is experimental, and it doesn't support all River components.
* Check out our [Reference][] documentation to find specific information you
might be looking for.

[Install]: {{< relref "./setup/install/" >}}
[Install]: {{< relref "./get-started/install/" >}}
[Concepts]: {{< relref "./concepts/" >}}
[Tasks]: {{< relref "./tasks/" >}}
[Tutorials]: {{< relref "./tutorials/ ">}}
Expand Down
25 changes: 25 additions & 0 deletions docs/sources/flow/get-started/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/get-started/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/get-started/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/get-started/
- /docs/grafana-cloud/send-data/agent/flow/get-started/
# Previous docs aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/setup/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/
- /docs/grafana-cloud/send-data/agent/flow/setup/
- ./setup/ # /docs/agent/latest/flow/setup/
canonical: https://grafana.com/docs/agent/latest/flow/get-started/
description: Learn how to install and use Grafana Agent Flow
menuTitle: Get started
title: Get started with Grafana Agent Flow
weight: 50
---

# Get started with {{% param "PRODUCT_NAME" %}}

This section covers topics that help you get started with {{< param "PRODUCT_NAME" >}},
including installation, running the agent, overview of deployment topologies, and more.

{{< section >}}
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/get-started/deploy-agent/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/get-started/deploy-agent/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/get-started/deploy-agent/
- /docs/grafana-cloud/send-data/agent/flow/get-started/deploy-agent/
# Previous docs aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/setup/deploy-agent/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/deploy-agent/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/deploy-agent/
- /docs/grafana-cloud/send-data/agent/flow/setup/deploy-agent/
canonical: https://grafana.com/docs/agent/latest/flow/setup/deploy-agent/
- ../setup/deploy-agent/ # /docs/agent/latest/flow/setup/deploy-agent/
canonical: https://grafana.com/docs/agent/latest/flow/get-started/deploy-agent/
description: Learn about possible deployment topologies for Grafana Agent Flow
menuTitle: Deploy Grafana Agent Flow
menuTitle: Deploy
title: Grafana Agent Flow deployment topologies
weight: 900
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/get-started/install/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/get-started/install/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/get-started/install/
- /docs/grafana-cloud/send-data/agent/flow/get-started/install/
# Previous docs aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/setup/install/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/install/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/install/
- /docs/grafana-cloud/send-data/agent/flow/setup/install/
- /docs/sources/flow/install/
canonical: https://grafana.com/docs/agent/latest/flow/setup/install/
- ../setup/install/ # /docs/agent/latest/flow/setup/install/
canonical: https://grafana.com/docs/agent/latest/flow/get-started/install/
description: Learn how to install Grafana Agent Flow
menuTitle: Install
title: Install Grafana Agent Flow
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
---
aliases:
- ../../install/binary/
- /docs/grafana-cloud/agent/flow/get-started/install/binary/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/get-started/install/binary/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/get-started/install/binary/
- /docs/grafana-cloud/send-data/agent/flow/get-started/install/binary/
# Previous docs aliases for backwards compatibility:
- ../../install/binary/ # /docs/agent/latest/flow/install/binary/
- /docs/grafana-cloud/agent/flow/setup/install/binary/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/install/binary/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/install/binary/
- /docs/grafana-cloud/send-data/agent/flow/setup/install/binary/
canonical: https://grafana.com/docs/agent/latest/flow/setup/install/binary/
- ../../setup/install/binary/ # /docs/agent/latest/flow/setup/install/binary/
canonical: https://grafana.com/docs/agent/latest/flow/get-started/install/binary/
description: Learn how to install Grafana Agent Flow as a standalone binary
menuTitle: Standalone
title: Install Grafana Agent Flow as a standalone binary
Expand Down Expand Up @@ -45,9 +51,9 @@ To download {{< param "PRODUCT_NAME" >}} as a standalone binary, perform the fol

## Next steps

- [Start {{< param "PRODUCT_NAME" >}}][Start]
- [Run {{< param "PRODUCT_NAME" >}}][Run]

{{% docs/reference %}}
[Start]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/setup/start/binary.md"
[Start]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/setup/start/binary.md"
[Run]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/get-started/run/binary.md"
[Run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/run/binary.md"
{{% /docs/reference %}}
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
---
aliases:
- ../../install/docker/
- /docs/grafana-cloud/agent/flow/get-started/install/docker/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/get-started/install/docker/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/get-started/install/docker/
- /docs/grafana-cloud/send-data/agent/flow/get-started/install/docker/
# Previous docs aliases for backwards compatibility:
- ../../install/docker/ # /docs/agent/latest/flow/install/docker/
- /docs/grafana-cloud/agent/flow/setup/install/docker/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/install/docker/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/install/docker/
- /docs/grafana-cloud/send-data/agent/flow/setup/install/docker/
canonical: https://grafana.com/docs/agent/latest/flow/setup/install/docker/
- ../../setup/install/docker/ # /docs/agent/latest/flow/setup/install/docker/
canonical: https://grafana.com/docs/agent/latest/flow/get-started/install/docker/
description: Learn how to install Grafana Agent Flow on Docker
menuTitle: Docker
title: Run Grafana Agent Flow in a Docker container
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
---
aliases:
- ../../install/kubernetes/
- /docs/grafana-cloud/agent/flow/get-started/install/kubernetes/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/get-started/install/kubernetes/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/get-started/install/kubernetes/
- /docs/grafana-cloud/send-data/agent/flow/get-started/install/kubernetes/
# Previous docs aliases for backwards compatibility:
- ../../install/kubernetes/ # /docs/agent/latest/flow/install/kubernetes/
- /docs/grafana-cloud/agent/flow/setup/install/kubernetes/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/install/kubernetes/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/install/kubernetes/
- /docs/grafana-cloud/send-data/agent/flow/setup/install/kubernetes/
canonical: https://grafana.com/docs/agent/latest/flow/setup/install/kubernetes/
- ../../setup/install/kubernetes/ # /docs/agent/latest/flow/setup/install/kubernetes/
canonical: https://grafana.com/docs/agent/latest/flow/get-started/install/kubernetes/
description: Learn how to deploy Grafana Agent Flow on Kubernetes
menuTitle: Kubernetes
title: Deploy Grafana Agent Flow on Kubernetes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
---
aliases:
- ../../install/linux/
- /docs/grafana-cloud/agent/flow/get-started/install/linux/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/get-started/install/linux/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/get-started/install/linux/
- /docs/grafana-cloud/send-data/agent/flow/get-started/install/linux/
# Previous docs aliases for backwards compatibility:
- ../../install/linux/ # /docs/agent/latest/flow/install/linux/
- /docs/grafana-cloud/agent/flow/setup/install/linux/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/install/linux/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/install/linux/
- /docs/grafana-cloud/send-data/agent/flow/setup/install/linux/
canonical: https://grafana.com/docs/agent/latest/flow/setup/install/linux/
- ../../setup/install/linux/ # /docs/agent/latest/flow/setup/install/linux/
canonical: https://grafana.com/docs/agent/latest/flow/get-started/install/linux/
description: Learn how to install Grafana Agent Flow on Linux
menuTitle: Linux
title: Install Grafana Agent Flow on Linux
Expand Down Expand Up @@ -119,12 +125,12 @@ To uninstall {{< param "PRODUCT_NAME" >}} on Linux, run the following commands i

## Next steps

- [Start {{< param "PRODUCT_NAME" >}}][Start]
- [Run {{< param "PRODUCT_NAME" >}}][Run]
- [Configure {{< param "PRODUCT_NAME" >}}][Configure]

{{% docs/reference %}}
[Start]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/setup/start/linux.md"
[Start]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/setup/start/linux.md"
[Run]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/get-started/run/linux.md"
[Run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/run/linux.md"
[Configure]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/configure/configure-linux.md"
[Configure]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/configure/configure-linux.md"
{{% /docs/reference %}}
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
---
aliases:
- ../../install/macos/
- /docs/grafana-cloud/agent/flow/get-started/install/macos/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/get-started/install/macos/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/get-started/install/macos/
- /docs/grafana-cloud/send-data/agent/flow/get-started/install/macos/
# Previous docs aliases for backwards compatibility:
- ../../install/macos/ # /docs/agent/latest/flow/install/macos/
- /docs/grafana-cloud/agent/flow/setup/install/macos/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/install/macos/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/install/macos/
- /docs/grafana-cloud/send-data/agent/flow/setup/install/macos/
canonical: https://grafana.com/docs/agent/latest/flow/setup/install/macos/
- ../../setup/install/macos/ # /docs/agent/latest/flow/setup/install/macos/
canonical: https://grafana.com/docs/agent/latest/flow/get-started/install/macos/
description: Learn how to install Grafana AgentFlow on macOS
menuTitle: macOS
title: Install Grafana Agent Flow on macOS
Expand Down Expand Up @@ -66,14 +72,14 @@ brew uninstall grafana-agent-flow

## Next steps

- [Start {{< param "PRODUCT_NAME" >}}][Start]
- [Run {{< param "PRODUCT_NAME" >}}][Run]
- [Configure {{< param "PRODUCT_NAME" >}}][Configure]

[Homebrew]: https://brew.sh

{{% docs/reference %}}
[Start]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/setup/start/macos.md"
[Start]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/setup/start/macos.md"
[Run]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/get-started/run/macos.md"
[Run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/run/macos.md"
[Configure]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/configure/configure-macos.md"
[Configure]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/configure/configure-macos.md"
{{% /docs/reference %}}
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
---
aliases:
- ../../install/windows/
- /docs/grafana-cloud/agent/flow/get-started/install/windows/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/get-started/install/windows/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/get-started/install/windows/
- /docs/grafana-cloud/send-data/agent/flow/get-started/install/windows/
# Previous docs aliases for backwards compatibility:
- ../../install/windows/ # /docs/agent/latest/flow/install/windows/
- /docs/grafana-cloud/agent/flow/setup/install/windows/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/install/windows/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/install/windows/
- /docs/grafana-cloud/send-data/agent/flow/setup/install/windows/
canonical: https://grafana.com/docs/agent/latest/flow/setup/install/windows/
- ../../setup/install/windows/ # /docs/agent/latest/flow/setup/install/windows/
canonical: https://grafana.com/docs/agent/latest/flow/get-started/install/windows/
description: Learn how to install Grafana Agent Flow on Windows
menuTitle: Windows
title: Install Grafana Agent Flow on Windows
Expand Down Expand Up @@ -78,14 +84,14 @@ This includes any configuration files in the installation directory.

## Next steps

- [Start {{< param "PRODUCT_NAME" >}}][Start]
- [Run {{< param "PRODUCT_NAME" >}}][Start]
- [Configure {{< param "PRODUCT_NAME" >}}][Configure]

[latest]: https://github.com/grafana/agent/releases/latest

{{% docs/reference %}}
[Start]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/setup/start/windows.md"
[Start]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/setup/start/windows.md"
[Run]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/get-started/run/windows.md"
[Run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/run/windows.md"
[Configure]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/configure/configure-windows.md"
[Configure]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/configure/configure-windows.md"
[data collection]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/data-collection.md"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/setup/start/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/start/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/start/
- /docs/grafana-cloud/send-data/agent/flow/setup/start/
- /docs/sources/flow/start/
- /docs/grafana-cloud/agent/flow/get-started/run/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/get-started/run/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/get-started/run/
- /docs/grafana-cloud/send-data/agent/flow/get-started/run/
- /docs/sources/flow/run/
# Previous pages aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/setup/start-agent/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/start-agent/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/start-agent/
- /docs/grafana-cloud/send-data/agent/flow/setup/start-agent/
- ./start-agent/ # /docs/agent/latest/flow/setup/start-agent/
canonical: https://grafana.com/docs/agent/latest/flow/setup/start/
description: Learn how to start Grafana Agent Flow
menuTitle: Start
title: Start Grafana Agent Flow
- ../setup/start-agent/ # /docs/agent/latest/flow/setup/start-agent/
canonical: https://grafana.com/docs/agent/latest/flow/get-started/run/
description: Learn how to run Grafana Agent Flow
menuTitle: Run
title: Run Grafana Agent Flow
weight: 50
---

# Start {{% param "PRODUCT_NAME" %}}
# Run {{% param "PRODUCT_NAME" %}}

Use the following pages to learn how to start, restart, and stop {{< param "PRODUCT_NAME" >}} after it is installed.
For installation instructions, refer to [Install {{< param "PRODUCT_NAME" >}}][Install].

{{< section >}}

{{% docs/reference %}}
[Install]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/setup/install/"
[Install]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/setup/install/"
[Install]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/get-started/install/"
[Install]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/install/"
{{% /docs/reference %}}
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/setup/start/binary/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/start/binary/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/start/binary/
- /docs/grafana-cloud/send-data/agent/flow/setup/start/binary/
canonical: https://grafana.com/docs/agent/latest/flow/setup/start/binary/
description: Learn how to start Grafana Agent Flow as a standalone binary
- /docs/grafana-cloud/agent/flow/get-started/run/binary/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/get-started/run/binary/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/get-started/run/binary/
- /docs/grafana-cloud/send-data/agent/flow/get-started/run/binary/
canonical: https://grafana.com/docs/agent/latest/flow/get-started/run/binary/
description: Learn how to run Grafana Agent Flow as a standalone binary
menuTitle: Standalone
title: Start Grafana Agent Flow as a standalone binary
title: Run Grafana Agent Flow as a standalone binary
weight: 600
---

# Start {{% param "PRODUCT_NAME" %}} as a standalone binary
# Run {{% param "PRODUCT_NAME" %}} as a standalone binary

If you [downloaded][InstallBinary] the standalone binary, you must run {{< param "PRODUCT_NAME" >}} from a terminal or command window.

Expand Down Expand Up @@ -119,8 +119,8 @@ These steps assume you have a default systemd and {{< param "PRODUCT_NAME" >}} c
1. Use the [Linux][StartLinux] systemd commands to manage your standalone Linux installation of {{< param "PRODUCT_NAME" >}}.

{{% docs/reference %}}
[InstallBinary]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/setup/install/binary.md"
[InstallBinary]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/flow/setup/install/binary.md"
[StartLinux]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/setup/start/linux.md"
[StartLinux]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/flow/setup/start/linux.md"
[InstallBinary]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/get-started/install/binary.md"
[InstallBinary]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/flow/get-started/install/binary.md"
[StartLinux]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/get-started/run/linux.md"
[StartLinux]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/flow/get-started/run/linux.md"
{{% /docs/reference %}}
Loading