Skip to content

Commit

Permalink
Add missing shared link syntax (#5156)
Browse files Browse the repository at this point in the history
* Add missing shared link syntax

* Fix spacing in shared link

* Add other missing shared syntax
  • Loading branch information
clayton-cornell authored Sep 11, 2023
1 parent 0cf05ba commit 04ef1a9
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/developer/writing-flow-component-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,13 @@ If documenting a beta component, include the following after the header, but
before the description of the component:

```markdown
{{< docs/shared lookup="flow/stability/beta.md" source="agent" >}}
{{< docs/shared lookup="flow/stability/beta.md" source="agent" version="<AGENT VERSION>" >}}
```

If documenting an experimental component, include the following instead:

```markdown
{{< docs/shared lookup="flow/stability/experimental.md" source="agent" >}}
{{< docs/shared lookup="flow/stability/experimental.md" source="agent" version="<AGENT VERSION>" >}}
```

### Usage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The following blocks are supported inside the definition of

### 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
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: otelcol.connector.servicegraph

# otelcol.connector.servicegraph

{{< docs/shared lookup="flow/stability/experimental.md" source="agent" >}}
{{< docs/shared lookup="flow/stability/experimental.md" source="agent" version="<AGENT VERSION>" >}}

`otelcol.connector.servicegraph` accepts span data from other `otelcol` components and
outputs metrics representing the relationship between various services in a system.
Expand Down Expand Up @@ -135,7 +135,7 @@ Name | Type | Description | Default | Required

### output block

{{< docs/shared lookup="flow/reference/components/output-block-metrics.md" source="agent" >}}
{{< docs/shared lookup="flow/reference/components/output-block-metrics.md" source="agent" version="<AGENT VERSION>" >}}

## Exported fields

Expand Down

0 comments on commit 04ef1a9

Please sign in to comment.