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

Add missing shared link syntax #5156

Merged
merged 3 commits into from
Sep 11, 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/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>" >}}
Copy link
Member

@tpaschalis tpaschalis Sep 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see a few other occurrences of this in case we want to bundle them here.

$ grep -r "docs/shared lookup" | grep -v "VERSION"
docs/developer/writing-flow-component-documentation.md:{{< docs/shared lookup="flow/stability/beta.md" source="agent" >}}
docs/developer/writing-flow-component-documentation.md:{{< docs/shared lookup="flow/stability/experimental.md" source="agent" >}}
docs/sources/flow/reference/components/discovery.consulagent.md:{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" >}}
docs/sources/flow/reference/components/otelcol.connector.servicegraph.md:{{< docs/shared lookup="flow/stability/experimental.md" source="agent" >}}
docs/sources/flow/reference/components/otelcol.connector.servicegraph.md:{{< docs/shared lookup="flow/reference/components/output-block-metrics.md" source="agent" >}}

Copy link
Contributor Author

@clayton-cornell clayton-cornell Sep 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can add them into the PR...

DONE


## Exported fields

Expand Down