Skip to content

[DOCS-14326] Update path notation content and add shortcode#36554

Open
maycmlee wants to merge 5 commits intomasterfrom
may/path-notation-update-shortcode
Open

[DOCS-14326] Update path notation content and add shortcode#36554
maycmlee wants to merge 5 commits intomasterfrom
may/path-notation-update-shortcode

Conversation

@maycmlee
Copy link
Copy Markdown
Contributor

@maycmlee maycmlee commented May 7, 2026

What does this PR do? What is the motivation?

  • Adds a path notation shortcode with content from Logs Search Syntax
  • Use shortcode for all docs with Path Notation sections

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.

AI assistance

Additional notes

@maycmlee maycmlee requested a review from a team as a code owner May 7, 2026 20:23
@maycmlee maycmlee added the WORK IN PROGRESS No review needed, it's a wip ;) label May 7, 2026
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label May 7, 2026
@maycmlee maycmlee removed the WORK IN PROGRESS No review needed, it's a wip ;) label May 8, 2026
@@ -0,0 +1 @@
To specify a nested field with a literal `.` in the attribute key, wrap the key in escaped quotes in the search query. For example, the search query `"service.status":disabled` matches the event `{"service.status": "disabled"}`.
Copy link
Copy Markdown

@clementd-dd clementd-dd May 11, 2026

Choose a reason for hiding this comment

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

nit: could this be merged with layouts/shortcodes/observability_pipelines/path_notation.en.md? are those ever displayed separately?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Hey @clementd-dd! I originally had this dot content in layouts/shortcodes/observability_pipelines/path_notation.en.md so there was only one shortcode. But then I realized the wording doesn't quite work for the log search syntax page, so I broke it out into a separate shortcode.

are those ever displayed separately?

If I'm understanding your question correctly, the answer is that it's not possible to split up the content within a shortcode, unfortunately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants