Skip to content

[docseng-37] copy sourced integrations earlier in the build process to generate placeholder pages #30321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

bgdeutsch
Copy link
Collaborator

@bgdeutsch bgdeutsch commented Jul 7, 2025

What does this PR do? What is the motivation?

This aims to solve the missing placeholder pages from integrations problem.

  • separates placeholders from the make dependencies chain so it can happen further down the line. we don't generate placeholders locally, so there's no need to call on it in the Makefile.
  • update make update_websites_sources_module to use hugo mod vendor, copy the sourced integrations markdown files from websites-sources into docs, and remove the vendor directory immediately. this should only happen in the CI. the _vendor folder is already gitignored and there is logic to prevent it from running locally anyway, so it would never be committed.

new order of operations would be:

  • dependencies
  • update_websites_sources_module
  • placeholders
    ...
  • build_site

now we have the integrations in the file system, we can generate placeholders for them.

https://datadoghq.atlassian.net/browse/DOCSENG-37

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

QA integrations page: https://docs-staging.datadoghq.com/brian.deutsch/docseng-37-placehold-apw-integrations/integrations/
QA integration details pages
pages that don't have placeholders in live have them in this preview for every language. for example:

Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com>
Copy link
Contributor

github-actions bot commented Jul 7, 2025

✅ Documentation Team Review

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

Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com>
@bgdeutsch bgdeutsch marked this pull request as ready for review July 8, 2025 17:00
@bgdeutsch bgdeutsch requested a review from a team as a code owner July 8, 2025 17:00
bgdeutsch added 2 commits July 8, 2025 13:11
Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com>
Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com>
@bgdeutsch bgdeutsch merged commit a109e36 into master Jul 9, 2025
19 checks passed
@bgdeutsch bgdeutsch deleted the brian.deutsch/docseng-37-placehold-apw-integrations branch July 9, 2025 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants