From 6992b484bc461cc0d2c02bafb621e1a283ce02db Mon Sep 17 00:00:00 2001 From: Daniel Lee Date: Fri, 9 Jun 2017 14:27:27 +0200 Subject: [PATCH] docs: improvements to building the docs readme Explains that you need to clone the grafana repo if you have not done that already. --- docs/README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 7aeab15888b..ff5ef6a4131 100644 --- a/docs/README.md +++ b/docs/README.md @@ -18,11 +18,28 @@ make docs-build **Build the Documentation**: Now that the docker image has been prepared we can build the -grafana docs and start a docs server. Switch your working directory back to the directory this file +grafana docs and start a docs server. + +If you have not cloned the Grafana repository already then: + +``` +cd .. +git clone https://github.com/grafana/grafana +``` + +Switch your working directory to the directory this file (README.md) is in. +``` +cd grafana/docs +``` + An AWS config file is required to build the docs Docker image and to publish the site to AWS. If you are building locally only and do not have any AWS credentials for docs.grafana.org then create an empty file named `awsconfig` in the current directory. +``` +touch awsconfig +``` + Then run (possibly with ``sudo``): ```