Summary

This repository serves as the source for the Datadog documentation website, built using the Hugo static site generator. It provides a centralized, maintainable platform for all Datadog technical documentation, benefiting users by offering a unified and up-to-date resource. Contributions are actively encouraged from both external users and Datadog employees.

How It Works

The documentation is written in Markdown and processed by Hugo, a static website generation tool, to create the live site. This approach leverages Markdown's simplicity for content creation and Hugo's efficiency for building and deploying a fast-loading website.

Quick Start & Requirements

Contributions are welcomed via pull requests (PRs) to the master branch. External contributors should fork the repository, while Datadog employees must use a specific branch naming convention (<name>/<description>) to enable CI previews. A GitHub bot automatically generates preview links for correctly named branches. Local builds are optional; consult the "Build setup guide" for details. The site uses Goldmark for Markdown, compliant with CommonMark 0.29.

Highlighted Details

• AI tools are utilized for content generation, but all submissions require human review to maintain quality standards.
• A strict lowercase file naming convention is mandatory due to the case-sensitive nature of the production build server.
• Merging to the master branch automatically triggers a site deployment, which usually completes within 35-45 minutes.
• Dedicated documentation exists for adding new integrations.

Maintenance & Community

Contributions are managed through a PR review process involving a dedicated Datadog Documentation team. PR titles may be updated with internal Jira ticket numbers (e.g., [DOCS-9000]) for tracking.

Licensing & Compatibility

The provided README does not explicitly state the repository's license.

Limitations & Caveats

All file names must be lowercase to avoid build failures on the case-sensitive production server. Large AI-generated PRs may require extended review times. Specific requirements for local builds are detailed in a separate guide, not within this README.