summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-11-09 10:58:50 +0100
committerChristian Poessinger <christian@poessinger.com>2019-11-09 10:58:50 +0100
commit3c681559ae0cb2660fb60c2173cf00516ad4f5a7 (patch)
tree3088b016ec078f595233c1bd1ccb0b0e2fda30a3 /README.md
parent4d42f5bfee1688af3d24d47b64b94cc476c7daca (diff)
downloadvyos-documentation-3c681559ae0cb2660fb60c2173cf00516ad4f5a7.tar.gz
vyos-documentation-3c681559ae0cb2660fb60c2173cf00516ad4f5a7.zip
README: reword instructions to match Dockerhub
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 19 insertions, 17 deletions
diff --git a/README.md b/README.md
index cbd37b63..8b8f5931 100644
--- a/README.md
+++ b/README.md
@@ -36,39 +36,41 @@ that is used to build a VyOS documentation.
## Setup
+You can either build the container on your own or directly fetch it prebuild
+from Dockerhub. If you want to build it for yourself, use the following command.
+
```bash
$ docker build -t vyos-docu docker
```
-### Build
+### Build documentation
-Linux
-```bash
-$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos-docu make html
+If the `vyos/vyos-documentation` container could not be found locally it will be
+automatically fetched from Dockerhub.
-# sphinx autobuild
-$ docker run --rm -it -p 8000:8000 -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos-docu make livehtml
-```
-
-Windows
-```powershell
-docker run --rm -it -v "$(pwd):/vyos" -w /vyos/docs vyos-docu make html
+```bash
+$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs \
+ -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make html
# sphinx autobuild
-docker run --rm -it -p 8000:8000 -v "$(pwd):/vyos" -w /vyos/docs vyos-docu make livehtml
+$ docker run --rm -it -p 8000:8000 -v "$(pwd)":/vyos -w /vyos/docs -e \
+ GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make livehtml
```
### Test the docs
-discuss in this Task: [T1731](https://phabricator.vyos.net/T1731)
+Discuss in this Phabricator task: [T1731](https://phabricator.vyos.net/T1731)
-to test all files:
+To test all files run:
```bash
-$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos-docu vale .
+$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs \
+ -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation vale .
```
-to test a specific file e.g. clustering.rst
+to test a specific file e.g. `clustering.rst`
+
```bash
-$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos-docu vale clustering.rst
+$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) \
+ -e GOSU_GID=$(id -g) vyos/vyos-documentation vale clustering.rst
```