Documentation site for Datadog
Built with hugo, a static website generation tool.
npm install -g yarn
Download the documentation repo
git clone https://github.com/DataDog/documentation.git
Run the server
documentation/ folder, create a
Makefile.config file from the Makefile.config.example
If you are a Datadog employee, add your Github personal token
To run the site and perform administrative tasks (compile metrics, create i18n placeholders, etc), just execute:
Documentation is available at
To learn more about how the documentation is build refer to the Documentation Build Wiki.
To use the Makefile, create a Makefile.config. See the instructions at the top of the Makefile.config.example.
After you have a config file you can run
make help to see options:
clean-build remove build artifacts. clean-exe remove execs. clean-integrations remove built integrations files. clean-node remove node_modules. clean-virt remove python virtual env. clean clean all make installs. hugpython build virtualenv used for tests. source-helpers source the helper functions used in build, test, deploy. start start the gulp/hugo server. stop stop the gulp/hugo server.
Working on Docs
- Always branch off of master; never commit directly to master.
- Name your branch
<SLACK_HANDLE>/<FEATURE_NAME>if you would like to create a preview site and run tests.
- When you are ready to commit, create a new pull request to master from your branch.
- Consult our contributing guidelines and the Documentation Build Wiki.
- Fork the master branch.
- When you are ready to commit make a pull request back to
- Consult our contributing guidelines.
A note about markdown
This site uses Blackfriday for markdown. To learn about the syntax, see this site.
If you include ANY Markdown in a file, give it an .md extension.
Make sure all files are lowercase. Macs are case insensitive when creating links to images and pages, but the server is not so tests may be fine locally but the site will fail in production.
If you receive an error regarding
There was a problem getting GitHub Metrics, please see the Github personal access token.
Within 5 minutes of merging to master, it deploys automatically.