Skip to content

Conversation

jhgilbert
Copy link
Contributor

@jhgilbert jhgilbert commented Oct 7, 2025

What does this PR do? What is the motivation?

I'm working on adding translation support for Cdocs, and realized we don't need to use the same pattern as Hugo (yourfilename.en.mdoc.md). Instead we can just have a directory per language, similar to content. This allows tech writers to ignore the translated content, hopefully reducing clutter in the files they're working with.

This PR just moves the partials to their intended destination to avoid merge conflicts down the road, no updates to translation logic are actually involved yet.

I've verified that the build breaks if a referenced partial doesn't exist, so this is a pretty safe update if the build passes and the preview pages work. They would be blank if the partial content weren't coming through.

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

@jhgilbert jhgilbert added the WORK IN PROGRESS No review needed, it's a wip ;) label Oct 7, 2025
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Oct 7, 2025
@jhgilbert jhgilbert changed the title Update Cdocs files to include the language in the partial file extension Reorganize mdoc partials to support simpler translation processes Oct 7, 2025
@jhgilbert jhgilbert removed the WORK IN PROGRESS No review needed, it's a wip ;) label Oct 7, 2025
@jhgilbert jhgilbert marked this pull request as ready for review October 7, 2025 20:08
@jhgilbert jhgilbert requested review from a team as code owners October 7, 2025 20:08
@jhgilbert jhgilbert merged commit 053c587 into master Oct 7, 2025
25 of 26 checks passed
@jhgilbert jhgilbert deleted the jen.gilbert/cdocs-translation-tweaks branch October 7, 2025 20:29
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.

2 participants