The source for Datadog's documentation site.
Welcome to the Datadog documentation repository. The markdown stored in this repo is published to the Datadog documentation site using hugo, a static website generation tool.
Contributions are encouraged! If you notice something on one of the pages that needs an edit, open a pull request in this repo for the documentation team to review
Most pages on the documentation site feature an Edit button that sends you to the source file in this repo. You can make an edit straight from the GitHub website!
For more information on contributing, see the contribution guidelines.
<SLACK_HANDLE>/<FEATURE_NAME>
. If you don’t use this convention, the Gitlab pipeline won’t run and you won’t get a branch preview. Getting a branch preview makes it easier for us to check for any issues with your PR, such as broken links.DataDog/master
.This site uses Goldmark for markdown, which is compliant with CommonMark 0.29.
If you include ANY Markdown in a file, give it a .md
extension.
Make sure all files are lowercase. Macs are case-insensitive when creating links to images and pages, but our build server is not, so tests may work locally, but the site will fail in production.
Within 10 minutes of merging to master, it deploys automatically.