Skip to content

Commit

Permalink
Fix some broken links and bad markdown syntax (#6596)
Browse files Browse the repository at this point in the history
* Correct canonical URL

* Update share syntax

* Remove table that was accidentally pasted in from discovery.dns

* Update docs/sources/flow/tutorials/flow-by-example/get-started.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Fix up the H1

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
  • Loading branch information
clayton-cornell and jdbaldry authored Mar 4, 2024
1 parent 2d4acba commit 72b08ca
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -135,19 +135,19 @@ The `operator` argument should be one of the following strings:

### basic_auth block

{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" >}}
{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" version="<AGENT_VERSION>" >}}

### authorization block

{{< docs/shared lookup="flow/reference/components/authorization-block.md" source="agent" >}}
{{< docs/shared lookup="flow/reference/components/authorization-block.md" source="agent" version="<AGENT_VERSION>" >}}

### oauth2 block

{{< docs/shared lookup="flow/reference/components/oauth2-block.md" source="agent" >}}
{{< docs/shared lookup="flow/reference/components/oauth2-block.md" source="agent" version="<AGENT_VERSION>">}}

### tls_config block

{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" >}}
{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" version="<AGENT_VERSION>">}}

## Exported fields

Expand Down
7 changes: 1 addition & 6 deletions docs/sources/flow/reference/config-blocks/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,7 @@ Name | Type | Description
`refresh_interval` | `duration` | Frequency to poll the URL for new sampling strategies. | `"1m"` | no

The remote sampling strategies are retrieved from the URL specified by the
`url` argument, and polled for updates on a timer. The frequency for how oftenName | Type | Description | Default | Required
---- | ---- | ----------- | ------- | --------
`names` | `list(string)` | DNS names to look up. | | yes
`port` | `number` | Port to use for collecting metrics. Not used for SRV records. | `0` | no
`refresh_interval` | `duration` | How often to query DNS for updates. | `"30s"` | no
`type` | `string` | Type of DNS record to query. Must be one of SRV, A, AAAA, or MX. | `"SRV"` | no
`url` argument, and polled for updates on a timer. The frequency for how often
polling occurs is controlled by the `refresh_interval` argument.

Requests to the remote sampling strategies server are made through an HTTP
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/flow/tutorials/flow-by-example/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ aliases:
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tutorials/flow-by-example/faq/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tutorials/flow-by-example/faq/
- /docs/grafana-cloud/send-data/agent/flow/tutorials/flow-by-example/faq/
canonical: https://grafana.com/docs/agent/latest/flow/tutorials/flow-by-example/faq/
canonical: https://grafana.com/docs/agent/latest/flow/tutorials/flow-by-example/get-started/
description: Getting started with Flow-by-Example Tutorials
title: Get started
weight: 10
---

## Who is this for?
# Get started

This set of tutorials contains a collection of examples that build on each other to demonstrate how to configure and use [{{< param "PRODUCT_NAME" >}}][flow]. It assumes you have a basic understanding of what {{< param "PRODUCT_ROOT_NAME" >}} is and telemetry collection in general. It also assumes a base level of familiarity with Prometheus and PromQL, Loki and LogQL, and basic Grafana navigation. It assumes no knowledge of {{< param "PRODUCT_NAME" >}} or River concepts.

Expand Down

0 comments on commit 72b08ca

Please sign in to comment.