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

Conversation

clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Sep 11, 2023

PR Description

The shared link syntax was missing the version="<AGENT VERSION>" part. This PR adds it to the topic.

Parent PR is: #5008

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Sep 11, 2023
@clayton-cornell clayton-cornell requested a review from a team September 11, 2023 16:28
@@ -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

Copy link
Member

@tpaschalis tpaschalis left a comment

Choose a reason for hiding this comment

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

LGTM, let's fix the rest of the occurrences too

@clayton-cornell clayton-cornell requested a review from a team as a code owner September 11, 2023 16:34
@clayton-cornell clayton-cornell enabled auto-merge (squash) September 11, 2023 16:35
@clayton-cornell clayton-cornell merged commit 04ef1a9 into main Sep 11, 2023
@clayton-cornell clayton-cornell deleted the docs/fix-shared-link-otelcol branch September 11, 2023 16:38
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 22, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants