IDP Getting Started guide #30019
IDP Getting Started guide #30019
Conversation
✅ Documentation Team ReviewThe documentation team has approved this pull request. Thank you for your contribution! |
Preview links (active after the
|
There was a problem hiding this comment.
@domalessi - Thanks for creating this guide! I really like how you've organized it. It's really easy to parse and the content is very clear. I left a few nit suggestions for you to consider. The most important one is to rename the title in the left nav, but otherwise, it's great!
| @@ -0,0 +1,189 @@ | |||
| --- | |||
There was a problem hiding this comment.
Note: Need to rename/update the menu file entry to use the correct URL and name. It is currently "Software Catalog" https://docs-staging.datadoghq.com/domalessi/idp-getting-started/getting_started/software_catalog/
| - Internal tooling adoption | ||
| - Ownership and documentation | ||
|
|
||
| Datadog Scorecards include 10 out-of-the-box rules across observability practices, ownership tagging, and production readiness checkpoints. You can group rules into levels to categorize them by their criticality-level 1 (basic expectations), level 2 (recommended practices), and level 3 (advanced/aspirational goals). |
There was a problem hiding this comment.
I think the list of criticality levels would be a bit easier to parse in a bulleted list, but it's also ok as is if you feel like the page has too many lists. 😄
Co-authored-by: Brett Blue <[email protected]>
|
/merge |
|
View all feedbacks in Devflow UI.
Added to the queue but the mergequeue is not enabled for now.
This pull request was merged directly. |
dd-devflow
bot
added
mergequeue-status: done
and removed
mergequeue-status: queued
labels
What does this PR do? What is the motivation?
https://datadoghq.atlassian.net/browse/DOCS-11158
Updates the Software Catalog Getting Started page to be an Internal Developer Portal Getting Started page, which includes info for Software Catalog as well as the other products within IDP (Scorecards, Engineering Reports, etc)
Merge instructions
Merge readiness:
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