Skip to content

Conversation

bgdeutsch
Copy link
Collaborator

@bgdeutsch bgdeutsch commented Aug 19, 2025

What does this PR do? What is the motivation?

  • reads integration markdown and websites-sources data from s3 at build time
  • removes websites-sources hugo module entirely

motivation:

  • hugo module is confusing for contributors, requires more security maintenance, and causes additional issues
  • more adaptable to next-gen docs (astro)
  • previous system in websites-sources required a PR with manual review/merge which causes bottlenecks
  • integration deploy system is triggered by APW so we will have docs publishing soon after they are in the app

Merge instructions

this is blocked on docs-ci pr first

Additional notes

Preview

preview site here (note this could get out of date):
https://docs-staging.datadoghq.com/brian.deutsch/docseng-99-s3

we need to check pages/data sourced from websites-sources and ensure it is building and rendering correctly.

examples:
integrations: https://docs-staging.datadoghq.com/brian.deutsch/docseng-99-s3/integrations
rbac permissions: https://docs-staging.datadoghq.com/brian.deutsch/docseng-99-s3/account_management/rbac/permissions
cloud siem content packs: https://docs-staging.datadoghq.com/brian.deutsch/docseng-99-s3/security/cloud_siem/content_packs/#overview
iac rules: https://docs-staging.datadoghq.com/brian.deutsch/docseng-99-s3/security/code_security/iac_security/iac_rules/
semantic core metrics mapping: https://docs-staging.datadoghq.com/brian.deutsch/docseng-99-s3/opentelemetry/mapping/metrics_mapping/

  • integrations tile list
  • integrations details pages
  • integrations in apw staging are reflected in the docs preview
  • docs data sources

Local Testing

going forward docs should be able to review integrations that are in the APW review bucket at the time of building locally. this would be the preferred method of confirming upstream changes.

be sure to run make clean-all first to ensure no artifacts are leftover from previous builds

pull this branch locally: make start-no-pre-build, and make start build successfully and render pages properly based on sourced data. (NOTE yarn start isn't working as of now due to the aws-permissions shortcode, this is known and being updated)

  • yarn start works (NOTE there is a known issue with this right now)
  • make start-no-pre-build works
  • make start works

Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com>
Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com>
Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com>
Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com>
@bgdeutsch bgdeutsch changed the title [docseng-99] reading integrations and sources data from s3 instead of hugo module [docseng-99] removes websites-sources hugo module Aug 20, 2025
@bgdeutsch bgdeutsch changed the title [docseng-99] removes websites-sources hugo module [docseng-99] removes websites-sources go module Aug 20, 2025
Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com>
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Aug 26, 2025
Copy link
Contributor

ℹ️ Documentation Team Review

No documentation team review is required for this pull request.

Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com>
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.

1 participant