Skip to content

Fix inter-readme anchor links regarding integrations #546

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.

Sign up for GitHub

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

Merged
bkabrda merged 1 commit into from
Feb 20, 2024
Merged

Fix inter-readme anchor links regarding integrations #546

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 2 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Contributor Author

@valscion valscion Feb 9, 2024

Choose a reason for hiding this comment

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

This approach of using a [some text](#anchor-name) link has been used once in the README.md already:

ansible-datadog/README.md

Line 564 in a543baa

**Note**: This configuration fails on Linux hosts. Only use it if the playbook is specific to Windows hosts. Otherwise, use the [inventory file method](#inventory-file).

So I figured this one could also be accepted.


#### Process check

Expand Down Expand Up @@ -357,7 +357,7 @@ To upgrade from Agent v6 to v7, use `datadog_agent_major_version: 7` to install

Use the `datadog_integration` resource to install a specific version of a Datadog integration. Keep in mind, the Agent comes with the [core integrations][19] already installed. This command is useful for upgrading a specific integration without upgrading the whole Agent. For more details, see [integration management][4].

If you want to configure an integration, refer to the `datadog_checks` [paragraph][21]
If you want to configure an integration, refer to the `datadog_checks` [paragraph](#integrations)

Available actions:

Expand Down Expand Up @@ -682,7 +682,5 @@ If you need to install the agent through Ansible but don't want to specify an AP
[18]: https://docs.datadoghq.com/security/cspm/setup/?tab=docker
[19]: https://github.com/DataDog/integrations-core
[20]: https://github.com/DataDog/integrations-extras
[21]: https://github.com/DataDog/ansible-datadog/tree/nschweitzer/readme#integrations
[22]: https://github.com/DataDog/ansible-datadog/tree/nschweitzer/readme#integrations-installation
[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
Comment on lines 685 to 686
Copy link
Contributor Author

@valscion valscion Feb 9, 2024

Choose a reason for hiding this comment

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

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 ☺️