Migrate the session replay mobile setup instructions to Cdocs #29079
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Preview links (active after the
|
jhgilbert
changed the title
…ilot-mobile-sr-setup' into jen.gilbert/cdocs-pilot-mobile-sr-setup
…ilot-mobile-sr-setup' into jen.gilbert/cdocs-pilot-mobile-sr-setup
jhgilbert
added
editorial review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
This converts the RUM Session Replay setup instructions to Markdoc. These instructions are used on two different pages, so I put the instructions in a partial, and converted both parent pages to
.mdoc.md.Impacted pages:
Notes for the websites team
The bump of the
cdocs-hugo-integrationpackage is just to fix header links, as you can see in the integration CHANGELOG.Notes for all reviewers
In Cdocs, code blocks are not collapsible by default. This was an oversight, but I actually prefer it here, and in general -- our code blocks are not very deep to begin with, so in most cases it seems like the utility of the toggle isn't worth the clutter of it. Regardless, I'll check in with Kari on this. If she wants them to collapse by default, I'll make the update in Cdocs, and the code blocks in these pages will once again be collapsible. I don't consider this a blocker.
There is no new content in this PR, just the setup of content filters and replacing Hugo shortcodes with Markdoc tags (like replacing tabs with if tags).
I've tweaked some Prettier/VS Code settings to fix some annoying issues around autoformatting / the Markdoc language server not providing code folding in some files.
I have QA'd these pages using the relevant items from the Cdocs QA list. I'm mainly just looking for a sanity check that nothing looks odd.
The features being QA'd for the first time are:
Merge readiness:
For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass in 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.
To have your PR automatically merged after it receives the required reviews, add the following PR comment:
Additional notes