Torkel Ödegaard ed2092e287 docs: updated alerting docs to make query conditions easier to understand, fixes #8486 8 tahun lalu
..
sources ed2092e287 docs: updated alerting docs to make query conditions easier to understand, fixes #8486 8 tahun lalu
Dockerfile 0b73369c4b docs: fixed docs title issue 8 tahun lalu
Makefile 24e3777894 docs: updated make file for docs to support specifying env and version 8 tahun lalu
README.md 982dc276d3 Update building docs readme 9 tahun lalu
VERSION 24e3777894 docs: updated make file for docs to support specifying env and version 8 tahun lalu
config.toml 19516ebcce docs: minor fix 8 tahun lalu
publish.sh ac6c93b3da docs: add publish bash script 8 tahun lalu
s3_website.json 15cb1d8980 Added grafana 1.x docs to main repo 10 tahun lalu

README.md

Building The Docs

To build the docs locally, you need to have docker installed. The docs are built using a custom docker image and the mkdocs tool.

Prepare the Docker Image:

Git clone grafana/grafana.org repo. Run these commands in the root of that repo. Note that you may require sudo when running make docs-build depending on how your system's docker service is configured):

$ git clone https://github.com/grafana/grafana.org
$ cd grafana.org
$ make docs-build

Build the Documentation:

Now that the docker image has been prepared we can build the docs. Switch your working directory back to the directory this file (README.md) is in and run (possibly with sudo):

$ make docs

This command will not return control of the shell to the user. Instead the command is now running a new docker container built from the image we created in the previous step.

Open localhost:3004 to view the docs.