IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-12-23 23:50:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: improvements to building the docs readme

Browse Source 
Explains that you need to clone the grafana repo if you have not done that already.
This commit is contained in:
Daniel Lee 2017-06-09 14:27:27 +02:00 committed by GitHub
parent cdd5ba6198
commit 6992b484bc
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/README.md
View File

@ -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``):
```