Skip to content

Conversation

domalessi
Copy link
Contributor

What does this PR do? What is the motivation?

https://datadoghq.atlassian.net/browse/DOCS-12128

This PR does the following:

  • Fleshes out the landing page for Software Catalog Setup
    • Some of these details exist already in subpages, but we wanted to provide a consolidated list of data sources that users can reference when setting up their Software Catalogs.
    • I'm torn on the formatting. Right now, each section is formatted in the following manner: header - nextlinks - details. I kept the nextlinks in there and put them immediately under the headers so that users could super easily navigate to the detailed Setup pages. The details underneath the nextlink sections are meant to help flesh out the picture for those interested without going into excessive detail or re-documenting everything already in individual Setup child pages.
  • Adds "correlation requirements" to the page describing autodiscovery from APM

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:

Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.

Additional notes

@domalessi domalessi requested a review from a team as a code owner October 2, 2025 18:48
@domalessi domalessi added the editorial review Waiting on a more in-depth review label Oct 2, 2025
@github-actions github-actions bot added the Images Images are added/removed with this PR label Oct 2, 2025
Copy link
Contributor

@brett0000FF brett0000FF left a comment

Choose a reason for hiding this comment

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

Nice work!

Re: your note on formatting, I think flipping the nextlinks to come after the description paragraph would improve the reading flow by giving context first.

A card-style layout could also work here. I've been experimenting with adding header tags to next links to achieve this effect: https://docs.datadoghq.com/opentelemetry/setup/

@domalessi domalessi merged commit 664a244 into master Oct 3, 2025
16 checks passed
@domalessi domalessi deleted the domalessi/software-catalog-datasources branch October 3, 2025 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial review Waiting on a more in-depth review Images Images are added/removed with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants