Built with hugo, a static website generation tool.
Install Python3 (you can also use pyenv)
Install yarn:
npm install -g yarnDownload the documentation repo
git clone https://github.com/DataDog/documentation.git
Inside 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 documentation site locally, execute:
| Command | Description |
|---|---|
make start-no-pre-build | Build the lightweight version of the documentation with no extra content |
make start | Build the full documentation with all extra content (integrations, extra pulled files, localised content...). Only useful if you have a Github personal token setup in your Makefile.config or the extra content is available localy. |
Documentation is then available at http://localhost:1313
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-all Clean everything.
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-no-pre-build Build the documentation without automatically pulled content.
start Build the documentation with all external content.
stop Stop wepack watch/hugo server.
- 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
DataDog/master. - Consult our contributing guidelines.
This site uses Goldmark for markdown which is compliant with CommonMark 0.29.
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.
Within 5 minutes of merging to master, it deploys automatically.