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

Replace < with % in var references in headings (#5975) #5982

Merged
merged 1 commit into from
Dec 15, 2023
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
4 changes: 2 additions & 2 deletions docs/sources/flow/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ cascade:
PRODUCT_ROOT_NAME: Grafana Agent
---

# {{< param "PRODUCT_NAME" >}}
# {{% param "PRODUCT_NAME" %}}

{{< param "PRODUCT_NAME" >}} is a _component-based_ revision of {{< param "PRODUCT_ROOT_NAME" >}} with a focus on ease-of-use,
debuggability, and ability to adapt to the needs of power users.
Expand Down Expand Up @@ -67,7 +67,7 @@ prometheus.remote_write "default" {
}
```

## {{< param "PRODUCT_ROOT_NAME" >}} configuration generator
## {{% param "PRODUCT_ROOT_NAME" %}} configuration generator

The {{< param "PRODUCT_ROOT_NAME" >}} [configuration generator](https://grafana.github.io/agent-configurator/) will help you get a head start on creating flow code.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Get started with Grafana Agent Flow
weight: 200
---

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

This section details guides for getting started with {{< param "PRODUCT_NAME" >}}.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: Configure Grafana Agent clustering in an existing installation
weight: 400
---

# Configure {{< param "PRODUCT_NAME" >}} clustering in an existing installation
# Configure {{% param "PRODUCT_NAME" %}} clustering in an existing installation

You can configure {{< param "PRODUCT_NAME" >}} to run with [clustering][] so that
individual {{< param "PRODUCT_ROOT_NAME" >}}s can work together for workload distribution and high
Expand All @@ -23,7 +23,7 @@ availability.

This topic describes how to add clustering to an existing installation.

## Configure {{< param "PRODUCT_NAME" >}} clustering with Helm Chart
## Configure {{% param "PRODUCT_NAME" %}} clustering with Helm Chart

This section guides you through enabling clustering when {{< param "PRODUCT_NAME" >}} is
installed on Kubernetes using the {{< param "PRODUCT_ROOT_NAME" >}} [Helm chart][install-helm].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Migrating from Grafana Agent Operator to Grafana Agent Flow
weight: 320
---

# Migrating from Grafana Agent Operator to {{< param "PRODUCT_NAME" >}}
# Migrating from Grafana Agent Operator to {{% param "PRODUCT_NAME" %}}

With the release of {{< param "PRODUCT_NAME" >}}, Grafana Agent Operator is no longer the recommended way to deploy {{< param "PRODUCT_ROOT_NAME" >}} in Kubernetes.
Some of the Operator functionality has been moved into {{< param "PRODUCT_NAME" >}} itself, and the remaining functionality has been replaced by our Helm Chart.
Expand All @@ -21,7 +21,7 @@ Some of the Operator functionality has been moved into {{< param "PRODUCT_NAME"

This guide will provide some steps to get started with {{< param "PRODUCT_NAME" >}} for users coming from Grafana Agent Operator.

## Deploy {{< param "PRODUCT_NAME" >}} with Helm
## Deploy {{% param "PRODUCT_NAME" %}} with Helm

1. You will need to create a `values.yaml` file, which contains options for deploying your {{< param "PRODUCT_ROOT_NAME" >}}.
You may start with the [default values](https://github.com/grafana/agent/blob/main/operations/helm/charts/grafana-agent/values.yaml) and customize as you see fit, or start with this snippet, which should be a good starting point for what the Operator does:
Expand Down Expand Up @@ -63,7 +63,7 @@ You may start with the [default values](https://github.com/grafana/agent/blob/ma

This command uses the `--set-file` flag to pass the configuration file as a Helm value, so that we can continue to edit it as a regular River file.

## Convert `MetricsIntances` to Flow components
## Convert `MetricsIntances` to {{% param "PRODUCT_NAME" %}} components

A `MetricsInstance` resource primarily defines:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: Migrate from Prometheus to Grafana Agent Flow
weight: 320
---

# Migrate from Prometheus to {{< param "PRODUCT_NAME" >}}
# Migrate from Prometheus to {{% param "PRODUCT_NAME" %}}

The built-in {{< param "PRODUCT_ROOT_NAME" >}} convert command can migrate your [Prometheus][] configuration to a {{< param "PRODUCT_NAME" >}} configuration.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: Migrate from Promtail to Grafana Agent Flow
weight: 330
---

# Migrate from Promtail to {{< param "PRODUCT_NAME" >}}
# Migrate from Promtail to {{% param "PRODUCT_NAME" %}}

The built-in {{< param "PRODUCT_ROOT_NAME" >}} convert command can migrate your [Promtail][]
configuration to a {{< param "PRODUCT_NAME" >}} configuration.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: Migrate Grafana Agent Static to Grafana Agent Flow
weight: 340
---

# Migrate from {{< param "PRODUCT_ROOT_NAME" >}} Static to {{< param "PRODUCT_NAME" >}}
# Migrate from {{% param "PRODUCT_ROOT_NAME" %}} Static to {{% param "PRODUCT_NAME" %}}

The built-in {{< param "PRODUCT_ROOT_NAME" >}} convert command can migrate your [Static][] configuration to a {{< param "PRODUCT_NAME" >}} configuration.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/monitoring/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ menuTitle: Monitoring
weight: 500
---

# Monitoring {{< param "PRODUCT_NAME" >}}
# Monitoring {{% param "PRODUCT_NAME" %}}

This section details various ways to monitor and debug {{< param "PRODUCT_NAME" >}}.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/monitoring/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Follow these steps to debug issues with {{< param "PRODUCT_NAME" >}}:
2. If the {{< param "PRODUCT_NAME" >}} UI doesn't help with debugging an issue, logs can be examined
instead.

## {{< param "PRODUCT_NAME" >}} UI
## {{% param "PRODUCT_NAME" %}} UI

{{< param "PRODUCT_NAME" >}} includes an embedded UI viewable from the {{< param "PRODUCT_ROOT_NAME" >}} HTTP
server, which defaults to listening at `http://localhost:12345`.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: Grafana Agent Flow Reference
weight: 600
---

# {{< param "PRODUCT_NAME" >}} Reference
# {{% param "PRODUCT_NAME" %}} Reference

This section provides reference-level documentation for the various parts of {{< param "PRODUCT_NAME" >}}:

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/cli/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: The Grafana Agent command-line interface
weight: 100
---

# The {{< param "PRODUCT_ROOT_NAME" >}} command-line interface
# The {{% param "PRODUCT_ROOT_NAME" %}} command-line interface

When in Flow mode, the `grafana-agent` binary exposes a command-line interface with
subcommands to perform various operations.
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/flow/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Release notes for Grafana Agent Flow
weight: 999
---

# Release notes for {{< param "PRODUCT_NAME" >}}
# Release notes for {{% param "PRODUCT_NAME" %}}

The release notes provide information about deprecations and breaking changes in {{< param "PRODUCT_NAME" >}}.

Expand Down Expand Up @@ -331,7 +331,7 @@ The change was made in PR [#18070](https://github.com/open-telemetry/opentelemet
The `remote_sampling` block in `otelcol.receiver.jaeger` has been an undocumented no-op configuration for some time, and has now been removed.
Customers are advised to use `otelcol.extension.jaeger_remote_sampling` instead.

### Deprecation: `otelcol.exporter.jaeger` has been deprecated and will be removed in {{< param "PRODUCT_NAME" >}} v0.38.0.
### Deprecation: `otelcol.exporter.jaeger` has been deprecated and will be removed in {{% param "PRODUCT_NAME" %}} v0.38.0.

This is because Jaeger supports OTLP directly and OpenTelemetry Collector is also removing its
[Jaeger receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/jaegerexporter).
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/setup/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: Set up Grafana Agent Flow
weight: 50
---

# Set up {{< param "PRODUCT_NAME" >}}
# Set up {{% param "PRODUCT_NAME" %}}

This section includes information that helps you install and configure {{< param "PRODUCT_NAME" >}}.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/setup/configure/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: Configure Grafana Agent Flow
weight: 150
---

# Configure {{< param "PRODUCT_NAME" >}}
# Configure {{% param "PRODUCT_NAME" %}}

You can configure {{< param "PRODUCT_NAME" >}} after it is installed. The default River configuration file for {{< param "PRODUCT_NAME" >}} is located at:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: Configure Grafana Agent Flow on Kubernetes
weight: 200
---

# Configure {{< param "PRODUCT_NAME" >}} on Kubernetes
# Configure {{% param "PRODUCT_NAME" %}} on Kubernetes

To configure {{< param "PRODUCT_NAME" >}} on Kubernetes, perform the following steps:

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/setup/configure/configure-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: Configure Grafana Agent Flow on Linux
weight: 300
---

# Configure {{< param "PRODUCT_NAME" >}} on Linux
# Configure {{% param "PRODUCT_NAME" %}} on Linux

To configure {{< param "PRODUCT_NAME" >}} on Linux, perform the following steps:

Expand Down
4 changes: 2 additions & 2 deletions docs/sources/flow/setup/configure/configure-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: Configure Grafana Agent Flow on macOS
weight: 400
---

# Configure {{< param "PRODUCT_NAME" >}} on macOS
# Configure {{% param "PRODUCT_NAME" %}} on macOS

To configure {{< param "PRODUCT_NAME" >}} on macOS, perform the following steps:

Expand All @@ -23,7 +23,7 @@ To configure {{< param "PRODUCT_NAME" >}} on macOS, perform the following steps:
brew services restart grafana-agent-flow
```

## Configure the {{< param "PRODUCT_NAME" >}} service
## Configure the {{% param "PRODUCT_NAME" %}} service

{{% admonition type="note" %}}
Due to limitations in Homebrew, customizing the service used by
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/setup/configure/configure-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: Configure Grafana Agent Flow on Windows
weight: 500
---

# Configure {{< param "PRODUCT_NAME" >}} on Windows
# Configure {{% param "PRODUCT_NAME" %}} on Windows

To configure {{< param "PRODUCT_NAME" >}} on Windows, perform the following steps:

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/setup/install/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Install Grafana Agent Flow
weight: 50
---

# Install {{< param "PRODUCT_NAME" >}}
# Install {{% param "PRODUCT_NAME" %}}

You can install {{< param "PRODUCT_NAME" >}} on Docker, Kubernetes, Linux, macOS, or Windows.

Expand Down
4 changes: 2 additions & 2 deletions docs/sources/flow/setup/install/binary.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Install Grafana Agent Flow as a standalone binary
weight: 600
---

# Install {{< param "PRODUCT_NAME" >}} as a standalone binary
# Install {{% param "PRODUCT_NAME" %}} as a standalone binary

{{< param "PRODUCT_NAME" >}} is distributed as a standalone binary for the following operating systems and architectures:

Expand All @@ -21,7 +21,7 @@ weight: 600
* macOS: AMD64 (Intel), ARM64 (Apple Silicon)
* FreeBSD: AMD64

## Download {{< param "PRODUCT_ROOT_NAME" >}}
## Download {{% param "PRODUCT_ROOT_NAME" %}}

To download {{< param "PRODUCT_NAME" >}} as a standalone binary, perform the following steps.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/setup/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Run Grafana Agent Flow in a Docker container
weight: 100
---

# Run {{< param "PRODUCT_NAME" >}} in a Docker container
# Run {{% param "PRODUCT_NAME" %}} in a Docker container

{{< param "PRODUCT_NAME" >}} is available as a Docker container image on the following platforms:

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/setup/install/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Deploy Grafana Agent Flow on Kubernetes
weight: 200
---

# Deploy {{< param "PRODUCT_NAME" >}} on Kubernetes
# Deploy {{% param "PRODUCT_NAME" %}} on Kubernetes

{{< param "PRODUCT_NAME" >}} can be deployed on Kubernetes by using the Helm chart for {{< param "PRODUCT_ROOT_NAME" >}}.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/setup/install/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Install Grafana Agent Flow on Linux
weight: 300
---

# Install or uninstall {{< param "PRODUCT_NAME" >}} on Linux
# Install or uninstall {{% param "PRODUCT_NAME" %}} on Linux

You can install {{< param "PRODUCT_NAME" >}} as a systemd service on Linux.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/setup/install/macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Install Grafana Agent Flow on macOS
weight: 400
---

# Install {{< param "PRODUCT_NAME" >}} on macOS
# Install {{% param "PRODUCT_NAME" %}} on macOS

You can install {{< param "PRODUCT_NAME" >}} on macOS with Homebrew .

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/setup/install/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Install Grafana Agent Flow on Windows
weight: 500
---

# Install {{< param "PRODUCT_NAME" >}} on Windows
# Install {{% param "PRODUCT_NAME" %}} on Windows

You can install {{< param "PRODUCT_NAME" >}} on Windows as a standard graphical install, or as a silent install.

Expand Down
Loading