The source for Datadog's documentation site.
HTML Python Shell Ruby JavaScript CSS Makefile
Clone or download
Latest commit 1a86f7c Jul 19, 2018
Permalink
Failed to load latest commit information.
.github Create CODEOWNERS Jun 27, 2018
.translate/templates update translations to have filterable templates Mar 22, 2018
config update preview url Nov 8, 2017
content Merge pull request #2804 from DataDog/gus/screen-update Jul 19, 2018
data adding suse logo Jun 21, 2018
i18n Adding translations Apr 7, 2018
ja adding missing content type Jul 13, 2018
layouts fix sorting: sort by filename Jul 16, 2018
local Merge pull request #2759 from DataDog/michaelw/pin-node-packages Jul 13, 2018
src Merge pull request #2804 from DataDog/gus/screen-update Jul 19, 2018
static consistent caps for Screenboard and Timeboard Jun 20, 2018
.editorconfig add editor config file Oct 2, 2017
.gitignore gitignore .swp files Jun 12, 2018
.gitlab-ci.yml turn off algolia indexing for docs Jul 12, 2018
CONTRIBUTING.md Updating link example Jul 6, 2018
LICENSE update copyright Oct 24, 2017
Makefile adding nxlog syslog_ng & rsyslog as integrations Jul 13, 2018
Makefile.config.example Pulling integrations from integations-extras Jan 4, 2018
README.md Removed stray S in a url that should not be https Jun 14, 2018
config.yaml Merge pull request #2802 from DataDog/nils/logging-without-limits Jul 19, 2018
gulpfile.js Merge remote-tracking branch 'origin/david.jones/redesign' into gus/r… Dec 12, 2017
package.json fix path Jul 12, 2018
translate.yaml don't send faq files to transifex anymore Apr 26, 2018
yarn.lock pin node packages; switch to yarn Jul 12, 2018

README.md

Documentation site for Datadog

Built with hugo, a static website generation tool.

Setup

Installation

Run the server

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 site without Docker and perform administrative tasks (compile metrics, create i18n placeholders, etc), just execute:

make start

Documentation is available at http://localhost:1313

To run the site with Docker (easier setup, slower server), install Docker then execute:

make docker-start

Makefile

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-docker              remove image.
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.
docker-start              start container and run default commands to start hugo site.
docker-stop               kill the site and stop the running container.
docker-tests              run the tests through the docker container.
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

Datadog Staff

  • Always branch off of master; never commit directly to master.
  • Name your branch slack_handle/your_feature 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

Outside Contributors

  • Fork the master branch
  • When you are ready to commit make a pull request back to DataDog/master
  • 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.

Releasing

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. You can see the status in the internal Datadog Slack #documentation channel.

How to add a new integration

See the dedicated doc page