Clean up some linting errors on faro.receiver (#2534)

* Clean up some linting errors on faro.receiver

* Add stage metadata

Author: clayton-cornell

docs/sources/reference/components/faro/faro.receiver.md

@@ -3,29 +3,31 @@ canonical: https://grafana.com/docs/alloy/latest/reference/components/faro/faro.
 aliases:
   - ../faro.receiver/ # /docs/alloy/latest/reference/components/faro.receiver/
 description: Learn about the faro.receiver
+labels:
+  stage: general-availability
 title: faro.receiver
 ---
 
-# faro.receiver
+# `faro.receiver`
 
-`faro.receiver` accepts web application telemetry data from the [Grafana Faro Web SDK][faro-sdk] and forwards it to other components for future processing.
+`faro.receiver` accepts web application telemetry data from the [Grafana Faro Web SDK][faro-sdk] and forwards it to other components for processing.
 
 [faro-sdk]: https://github.com/grafana/faro-web-sdk
 
 ## Usage
 
 ```alloy
-faro.receiver "LABEL" {
+faro.receiver "<LABEL>" {
     output {
-        logs   = [LOKI_RECEIVERS]
-        traces = [OTELCOL_COMPONENTS]
+        logs   = [<LOKI_RECEIVERS>]
+        traces = [<OTELCOL_COMPONENTS>]
     }
 }
 ```
 
 ## Arguments
 
-The following arguments are supported:
+You can use the following arguments with `faro.receiver`:
 
 Name               | Type          | Description                                  | Default | Required
 -------------------|---------------|----------------------------------------------|---------|---------
@@ -34,30 +36,39 @@ Name               | Type          | Description
 
 ### Log format
 
-The following strings are recognized as valid log line formats:
+The following strings are valid log line formats:
 
-* `"logfmt"`: Export logs as [logfmt](https://brandur.org/logfmt) lines.
 * `"json"`: Export logs as JSON objects.
+* `"logfmt"`: Export logs as [`logfmt`](https://brandur.org/logfmt) lines.
 
 ## Blocks
 
-The following blocks are supported inside the definition of `faro.receiver`:
+You can use the following blocks with `faro.receiver`:
 
-Hierarchy              | Block             | Description                                          | Required
------------------------|-------------------|------------------------------------------------------|---------
-server                 | [server][]        | Configures the HTTP server.                          | no
-server > rate_limiting | [rate_limiting][] | Configures rate limiting for the HTTP server.        | no
-sourcemaps             | [sourcemaps][]    | Configures sourcemap retrieval.                      | no
-sourcemaps > location  | [location][]      | Configures on-disk location for sourcemap retrieval. | no
-output                 | [output][]        | Configures where to send collected telemetry data.   | yes
+Block                                        | Description                                          | Required
+---------------------------------------------|------------------------------------------------------|---------
+[`output`][output]                           | Configures where to send collected telemetry data.   | yes
+[`server`][server]                           | Configures the HTTP server.                          | no
+`server` >  [`rate_limiting`][rate_limiting] | Configures rate limiting for the HTTP server.        | no
+[`sourcemaps`][sourcemaps]                   | Configures sourcemap retrieval.                      | no
+`sourcemaps` >  [`location`][location]       | Configures on-disk location for sourcemap retrieval. | no
 
-[server]: #server-block
-[rate_limiting]: #rate_limiting-block
-[sourcemaps]: #sourcemaps-block
-[location]: #location-block
-[output]: #output-block
+[location]: #location
+[output]: #output
+[rate_limiting]: #rate_limiting
+[server]: #server
+[sourcemaps]: #sourcemaps
 
-### server block
+### `output`
+
+The `output` block specifies where to forward collected logs and traces.
+
+Name     | Type                     | Description                                          | Default | Required
+---------|--------------------------|------------------------------------------------------|---------|---------
+`logs`   | `list(LogsReceiver)`     | A list of `loki` components to forward logs to.      | `[]`    | no
+`traces` | `list(otelcol.Consumer)` | A list of `otelcol` components to forward traces to. | `[]`    | no
+
+### `server`
 
 The `server` block configures the HTTP server managed by the `faro.receiver` component.
 Clients using the [Grafana Faro Web SDK][faro-sdk] forward telemetry data to this HTTP server for processing.
@@ -83,7 +94,7 @@ When the `api_key` argument is non-empty, client requests must have an HTTP head
 Requests that are missing the header or have the wrong value are rejected with an `HTTP 401 Unauthorized` status code.
 If the `api_key` argument is empty, no authentication checks are performed, and the `X-API-Key` HTTP header is ignored.
 
-### rate_limiting block
+#### `rate_limiting`
 
 The `rate_limiting` block configures rate limiting for client requests.
 
@@ -95,13 +106,13 @@ Name         | Type     | Description                          | Default | Requi
 
 Rate limiting functions as a [token bucket algorithm][token-bucket], where a bucket has a maximum capacity for up to `burst_size` requests and refills at a rate of `rate` per second.
 
-Each HTTP request drains the capacity of the bucket by one. Once the bucket is empty, HTTP requests are rejected with an `HTTP 429 Too Many Requests` status code until the bucket has more available capacity.
+Each HTTP request drains the capacity of the bucket by one. After the bucket is empty, HTTP requests are rejected with an `HTTP 429 Too Many Requests` status code until the bucket has more available capacity.
 
 Configuring the `rate` argument determines how fast the bucket refills, and configuring the `burst_size` argument determines how many requests can be received in a burst before the bucket is empty and starts rejecting requests.
 
 [token-bucket]: https://en.wikipedia.org/wiki/Token_bucket
 
-### sourcemaps block
+### `sourcemaps`
 
 The `sourcemaps` block configures how to retrieve sourcemaps.
 Sourcemaps are then used to transform file and line information from minified code into the file and line information from the original source code.
@@ -124,59 +135,49 @@ By default, sourcemap downloads are subject to a timeout of `"1s"`, specified by
 Setting `download_timeout` to `"0s"` disables timeouts.
 
 To retrieve sourcemaps from disk instead of the network, specify one or more [`location` blocks][location].
-When `location` blocks are provided, they are checked first for sourcemaps before falling back to downloading.
+When `location` blocks are provided, they're checked first for sourcemaps before falling back to downloading.
 
-### location block
+#### `location`
 
 The `location` block declares a location where sourcemaps are stored on the filesystem.
-The `location` block can be specified multiple times to declare multiple locations where sourcemaps are stored.
+You can specify the `location` block multiple times to declare multiple locations where sourcemaps are stored.
 
 Name                   | Type     | Description                                         | Default | Required
 -----------------------|----------|-----------------------------------------------------|---------|---------
-`path`                 | `string` | The path on disk where sourcemaps are stored.       |         | yes
 `minified_path_prefix` | `string` | The prefix of the minified path sent from browsers. |         | yes
+`path`                 | `string` | The path on disk where sourcemaps are stored.       |         | yes
 
-The `minified_path_prefix` argument determines the prefix of paths to Javascript files, such as `http://example.com/`.
+The `minified_path_prefix` argument determines the prefix of paths to JavaScript files, such as `http://example.com/`.
 The `path` argument then determines where to find the sourcemap for the file.
 
 For example, given the following location block:
 
-```
+```alloy
 location {
     path                 = "/var/my-app/build"
     minified_path_prefix = "http://example.com/"
 }
 ```
 
-To look up the sourcemaps for a file hosted at `http://example.com/foo.js`, the `faro.receiver` component will:
+To look up the sourcemaps for a file hosted at `http://example.com/example.js`, the `faro.receiver` component:
 
-1. Remove the minified path prefix to extract the path to the file (`foo.js`).
-2. Search for that file path with a `.map` extension (`foo.js.map`) in `path` (`/var/my-app/build/foo.js.map`).
+1. Removes the minified path prefix to extract the path to the file `example.js`.
+1. Searches the path for the file with a `.map` extension, for example `example.js.map` in the path `/var/my-app/build/example.js.map`.
 
 Optionally, the value for the `path` argument may contain `{{ .Release }}` as a template value, such as `/var/my-app/{{ .Release }}/build`.
-The template value will be replaced with the release value provided by the [Faro Web App SDK][faro-sdk].
-
-### output block
-
-The `output` block specifies where to forward collected logs and traces.
-
-Name     | Type                     | Description                                          | Default | Required
----------|--------------------------|------------------------------------------------------|---------|---------
-`logs`   | `list(LogsReceiver)`     | A list of `loki` components to forward logs to.      | `[]`    | no
-`traces` | `list(otelcol.Consumer)` | A list of `otelcol` components to forward traces to. | `[]`    | no
+The template value is replaced with the release value provided by the [Faro Web App SDK][faro-sdk].
 
 ## Exported fields
 
-`faro.receiver` does not export any fields.
+`faro.receiver` doesn't export any fields.
 
 ## Component health
 
-`faro.receiver` is reported as unhealthy when the integrated server fails to
-start.
+`faro.receiver` is reported as unhealthy when the integrated server fails to start.
 
 ## Debug information
 
-`faro.receiver` does not expose any component-specific debug information.
+`faro.receiver` doesn't expose any component-specific debug information.
 
 ## Debug metrics
 
@@ -200,13 +201,13 @@ start.
 ```alloy
 faro.receiver "default" {
     server {
-        listen_address = "NETWORK_ADDRESS"
+        listen_address = "<NETWORK_ADDRESS>"
     }
 
     sourcemaps {
         location {
-            path                 = "PATH_TO_SOURCEMAPS"
-            minified_path_prefix = "WEB_APP_PREFIX"
+            path                 = "<PATH_TO_SOURCEMAPS>"
+            minified_path_prefix = "<WEB_APP_PREFIX>"
         }
     }
 
@@ -224,29 +225,21 @@ loki.write "default" {
 
 otelcol.exporter.otlp "traces" {
     client {
-        endpoint = "OTLP_ADDRESS"
+        endpoint = "<OTLP_ADDRESS>"
     }
 }
 ```
 
 Replace the following:
 
-* `NETWORK_ADDRESS`: IP address of the network interface to listen to traffic on.
+* _`<NETWORK_ADDRESS>`_: The IP address of the network interface to listen to traffic on.
   This IP address must be reachable by browsers using the web application to instrument.
-
-* `PATH_TO_SOURCEMAPS`: Path on disk where sourcemaps are located.
-
-* `WEB_APP_PREFIX`: Prefix of the web application being instrumented.
-
+* _`<PATH_TO_SOURCEMAPS>`_: The path on disk where sourcemaps are located.
+* _`<WEB_APP_PREFIX>`_: Prefix of the web application being instrumented.
 * `LOKI_ADDRESS`: Address of the Loki server to send logs to.
-
-  * If authentication is required to send logs to the Loki server, refer to the
-    documentation of [loki.write][] for more information.
-
-* `OTLP_ADDRESS`: The address of the OTLP-compatible server to send traces to.
-
-  * If authentication is required to send logs to the Loki server, refer to the
-    documentation of [otelcol.exporter.otlp][] for more information.
+  Refer to [`loki.write`][loki.write] if you want to use authentication to send logs to the Loki server.
+* _`<OTLP_ADDRESS>`_: The address of the OTLP-compatible server to send traces to.
+  Refer to[`otelcol.exporter.otlp`][otelcol.exporter.otlp] if you want to use authentication to send logs to the Loki server.
 
 [loki.write]: ../../loki/loki.write/
 [otelcol.exporter.otlp]: ../../otelcol/otelcol.exporter.otlp/