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

(cherry picked from commit 7e0bf25)
grafana · Dec 14, 2023 · 26647ca · 26647ca
1 parent e5a2e4a
commit 26647ca
Show file tree

Hide file tree

Showing 26 changed files with 46 additions and 46 deletions.
diff --git a/docs/sources/flow/_index.md b/docs/sources/flow/_index.md
@@ -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.
@@ -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.
 

diff --git a/docs/sources/flow/getting-started/_index.md b/docs/sources/flow/getting-started/_index.md
@@ -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" >}}.
 

diff --git a/docs/sources/flow/getting-started/configure-agent-clustering.md b/docs/sources/flow/getting-started/configure-agent-clustering.md
@@ -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
@@ -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].

diff --git a/docs/sources/flow/getting-started/migrating-from-operator.md b/docs/sources/flow/getting-started/migrating-from-operator.md
@@ -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.
@@ -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:
@@ -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:
 

diff --git a/docs/sources/flow/getting-started/migrating-from-prometheus.md b/docs/sources/flow/getting-started/migrating-from-prometheus.md
@@ -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.
 

diff --git a/docs/sources/flow/getting-started/migrating-from-promtail.md b/docs/sources/flow/getting-started/migrating-from-promtail.md
@@ -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.

diff --git a/docs/sources/flow/getting-started/migrating-from-static.md b/docs/sources/flow/getting-started/migrating-from-static.md
@@ -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.
 

diff --git a/docs/sources/flow/monitoring/_index.md b/docs/sources/flow/monitoring/_index.md
@@ -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" >}}.
 

diff --git a/docs/sources/flow/monitoring/debugging.md b/docs/sources/flow/monitoring/debugging.md
@@ -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`.

diff --git a/docs/sources/flow/reference/_index.md b/docs/sources/flow/reference/_index.md
@@ -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" >}}:
 

diff --git a/docs/sources/flow/reference/cli/_index.md b/docs/sources/flow/reference/cli/_index.md
@@ -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.

diff --git a/docs/sources/flow/release-notes.md b/docs/sources/flow/release-notes.md
@@ -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" >}}.
 
@@ -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).

diff --git a/docs/sources/flow/setup/_index.md b/docs/sources/flow/setup/_index.md
@@ -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" >}}.
 

diff --git a/docs/sources/flow/setup/configure/_index.md b/docs/sources/flow/setup/configure/_index.md
@@ -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:
 

diff --git a/docs/sources/flow/setup/configure/configure-kubernetes.md b/docs/sources/flow/setup/configure/configure-kubernetes.md
@@ -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:
 

diff --git a/docs/sources/flow/setup/configure/configure-linux.md b/docs/sources/flow/setup/configure/configure-linux.md
@@ -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:
 

diff --git a/docs/sources/flow/setup/configure/configure-macos.md b/docs/sources/flow/setup/configure/configure-macos.md
@@ -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:
 
@@ -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

diff --git a/docs/sources/flow/setup/configure/configure-windows.md b/docs/sources/flow/setup/configure/configure-windows.md
@@ -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:
 

diff --git a/docs/sources/flow/setup/install/_index.md b/docs/sources/flow/setup/install/_index.md
@@ -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.
 

diff --git a/docs/sources/flow/setup/install/binary.md b/docs/sources/flow/setup/install/binary.md
@@ -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:
 
@@ -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.
 

diff --git a/docs/sources/flow/setup/install/docker.md b/docs/sources/flow/setup/install/docker.md
@@ -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:
 

diff --git a/docs/sources/flow/setup/install/kubernetes.md b/docs/sources/flow/setup/install/kubernetes.md
@@ -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" >}}.
 

diff --git a/docs/sources/flow/setup/install/linux.md b/docs/sources/flow/setup/install/linux.md
@@ -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.
 

diff --git a/docs/sources/flow/setup/install/macos.md b/docs/sources/flow/setup/install/macos.md
@@ -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 .
 

diff --git a/docs/sources/flow/setup/install/windows.md b/docs/sources/flow/setup/install/windows.md
@@ -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.