This docker image will allow you to contribute documentation as found on http://docs.datadoghq.com.
Running the container
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.
Next clone the documentation repo and run the following from within the repo folder:
docker run -ti \ -v $PWD:/docs \ -p 3000:80 \ -e github_personal_token=$github_personal_token \ jyee/docker-dd-docs
Community contributors do not have access to the Dogweb, but you can still help with documentation. Just clone the documentation repo and run the following:
docker run -ti \ -v $PWD:/docs \ -p 3000:80 \ jyee/docker-dd-docs
Working on documentation
The container will automatically run the rake process and create the documentation html files. Once the process completes, you can view the docs in any browser by visiting http://localhost:3000.
You should edit the documentation files on your host machine and docker container will automatically regenerate files as it sees updates.
Depending on your particular host OS and Docker environment, it is possible that the Guard process will not automatically detect file changes. If Guard fails, you can manually run the process by first starting the docker container as:
docker run -ti \ -v $PWD:/docs \ -p 3000:80 \ -e github_personal_token=$github_personal_token \ jyee/docker-dd-docs \ /bin/sh
Note that you should include or exclude the github personal token as mentioned above in the Staff vs. Community contributors sections.
Once you are at the container command line prompt, you can manually run
rake clean to reset the environment, followed by
rake to build the documentation site. As you update or modify files, simply rerun