mstbbs/docker-dd-docs repository overview

This docker image will allow you to contribute documentation as found on http://docs.datadoghq.com⁠.

⁠Running the container

⁠Datadog staff

The documentation site automatically pulls metrics definitions from the Datadog application (known as Dogweb).

If you are an employee or otherwise have access to the Dogweb repository, first set your Github personal token as explained in the documentation repo setup.

⁠Community contributors

Community contributors do not have access to the Dogweb, but you can still help with documentation. Just clone the documentation repo.

⁠Working on documentation

To start the local environment run

make docker-start

The container will automatically create the documentation html files. Once the process completes, you can view the docs in any browser by visiting http://localhost:1313⁠.

You should edit the documentation files on your host machine and docker container will automatically regenerate files as it sees updates.