Pup CLI [DOCS-14159]#36640
Conversation
Preview links (active after the
|
|
Opened DOCS-14383 to follow up with editorial review. |
- shorten agent env vars, link to readme - shorten auth, link to readme - add global flags
Co-authored-by: Cara Reaume <35357020+clreaume@users.noreply.github.com>
clreaume
left a comment
There was a problem hiding this comment.
approving with one piece of feedback that follows up on this comment:
I hear that generic names for root-level UI items help to future-proof (and from an IA perspective, I'd expect them to be somewhat generic as root items are typically broad, with children getting more specific). I don't have issue with there being a root-level Command Line nav item (/cli), I just think it reads like a hub for all Datadog CLIs (from a quick search: datadog-ci, Agent CLI, Synthetics CLI, now-deprecated Dogshell)—even if just a short reference directory linking out to the docs for these other tools
as it is now, as a new user coming to the Essentials section, I would find it a bit confusing for the "Command Line" nav item to be docs for only one tool. I would think, wait, does DD only have one CLI tool? or, if they have multiple, is this one the most essential to core workflows?
to mitigate, I see two paths:
- idea one: leaving the Command Line nav label as-is, in Essentials, but adding a top-level page actually named "Command Line Tools" that's a quick reference for all DD CLI tools. then making Pup CLI a child page of that page
- idea two: moving Pup CLI to be next to/on the same level as MCP Server. I don't like that this is under "Bits AI" and would prefer if MCP Server and Pup CLI were both under a new heading called "AI Agent Resources" or similar (I think you've mentioned moving MCP Server out is planned), but I think it living here is tolerable in the interim
but if this is on a tight timeline for DASH, I can understand getting it out and revisiting this issue later. up to you!
What does this PR do? What is the motivation?
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.
AI assistance
Claude Code for initial planning and drafting.
Additional notes