Fix inter-readme anchor links regarding integrations #546
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
valscion
commented
Feb 9, 2024
Comment on lines
685
to
686
| [23]: https://docs.datadoghq.com/tracing/trace_collection/library_injection_local/?tab=agentandappinseparatecontainers#configure-docker-injection | ||
| [24]: https://docs.datadog.com/tracing/trace_collection/library_injection_local |
There was a problem hiding this comment.
I can change these numbers to [21] and [22] respectively if you'd like to avoid having empty slots in the numbering here. I first opted to do a smaller changeset to make this PR easier to review but let me know if you'd like me to change these as well
valscion
commented
Feb 9, 2024
| @@ -101,7 +101,7 @@ The API key is required and its absence causes the role to fail. If you want to | |||
|
|
|||
| To configure a Datadog integration (check), add an entry to the `datadog_checks` section. The first level key is the name of the check, and the value is the YAML payload to write the configuration file. Examples are provided below. | |||
|
|
|||
| To install or remove an integration, refer to the `datadog_integrations` [paragraph][22] | |||
| To install or remove an integration, refer to the `datadog_integration` [paragraph](#integration-installation) | |||
There was a problem hiding this comment.
This approach of using a [some text](#anchor-name) link has been used once in the README.md already:
Line 564 in a543baa
So I figured this one could also be accepted.
|
Thank you for the contribution @valscion , we'll have someone from the Documentation and ansible teams review this further. |
bkabrda
approved these changes
Feb 20, 2024
|
LGTM, I'm merging. Thanks a lot for the PR @valscion |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The links to refer to how to use
datadog_integrationare pointing to a repository+branch combination that no longer works.I spent some time figuring out how these integrations are supposed to be setup and these anchor links being broken took a while longer 😅
You can see the rendered README.md here: https://github.com/valscion/ansible-datadog/tree/patch-1