Skip to content

Initial version of x-org paging docs - #30983

Merged
cswatt merged 10 commits into
masterfrom
daljeet/x-org-paging
Aug 15, 2025
Merged

cswatt merged 10 commits into
masterfrom
daljeet/x-org-paging

Conversation

@Dalje-et

@Dalje-et Dalje-et commented Aug 8, 2025

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

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

@Dalje-et
Dalje-et requested a review from a team as a code owner August 8, 2025 11:48
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label Aug 8, 2025
@github-actions

github-actions Bot commented Aug 8, 2025 •

Copy link
Copy Markdown
Contributor

✅ Documentation Team Review

The documentation team has approved this pull request. Thank you for your contribution!

@drichards-87

Copy link
Copy Markdown
Collaborator

@Dalje-et Is this PR related to #30985?

@drichards-87 drichards-87 self-assigned this Aug 8, 2025
@drichards-87 drichards-87 added the editorial review Waiting on a more in-depth review label Aug 8, 2025
@github-actions

github-actions Bot commented Aug 11, 2025 •

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

New or renamed files

@Dalje-et Dalje-et changed the title [WIP] Initial version of x-org paging docs Initial version of x-org paging docs Aug 11, 2025
@drichards-87

Copy link
Copy Markdown
Collaborator

Created DOCS-11771 for Docs Team review.

@drichards-87 drichards-87 removed their assignment Aug 11, 2025
@cswatt

cswatt commented Aug 12, 2025

Copy link
Copy Markdown
Contributor

I pushed some changes:

  • We love having a "why you should use this" segment on pages like this. Usually there's not enough motivation-related content, but this time, there was maybe too much of it (the same sentiment was repeated a few times) and verged into marketing-sounding territory. I edited this down.
  • Renamed headings and restructured sections to align with the format and conventions of other documentation pages (for example, "How it works" is typically the heading for a section that explains the under-the-hood workings of a feature, not for a setup/config flow)
  • Consolidated setup steps into a numbered list.
  • Added a "get an API key" step, since users need to supply a destination org API key when creating a connection.
  • Added more explicit instructions around connection creation.
  • Added links
  • Various minor style/grammar edits

@github-actions github-actions Bot removed the Architecture Everything related to the Doc backend label Aug 14, 2025
@cswatt
cswatt merged commit 3133dc9 into master Aug 15, 2025
17 of 18 checks passed
@cswatt
cswatt deleted the daljeet/x-org-paging branch August 15, 2025 16:00
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants