Skip to content

Latest commit

 

History

History
108 lines (67 loc) · 4.4 KB

README.md

File metadata and controls

108 lines (67 loc) · 4.4 KB

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 https://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

Github personal token

Integrations that have metrics attempts to read the metrics metadata list from the metadata.csv file in the Datadog web application repo. This requires read access to that repository and your Github Personal Token. If you are not a Datadog employee, please skip this step.

For more information on generating a token, see Github's documentation.

After you've generated a token, add the following line to the .bash_profile in your home directory:

export github_personal_token=[paste access token here]

You should then run source ~/.bash_profile to reload the settings.

Update your Makefile.config to:

FETCH_INTEGRATIONS = true