Skip to content

Commit 498a960

Browse files
committed
readme: Improve Docker instructions
1 parent a5fcebd commit 498a960

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -90,26 +90,26 @@ If the `vyos/vyos-documentation` container could not be found locally it will be
9090
automatically fetched from Dockerhub.
9191

9292
```bash
93-
$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs \
94-
-e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make html
93+
$ git clone https://github.com/vyos/vyos-documentation.git
9594

96-
# sphinx autobuild
97-
$ docker run --rm -it -p 8000:8000 -v "$(pwd)":/vyos -w /vyos/docs -e \
98-
GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make livehtml
95+
$ cd vyos-documentation
96+
97+
$ 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
98+
99+
# For sphinx autobuild
100+
$ 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
99101
```
100102

101103
### Test the docs
102104

103105
To test all files, run:
104106

105107
```bash
106-
$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs \
107-
-e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation vale .
108+
$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation vale .
108109
```
109110

110111
to test a specific file (e.g. `quick-start.rst`)
111112

112113
```bash
113-
$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) \
114-
-e GOSU_GID=$(id -g) vyos/vyos-documentation vale quick-start.rst
114+
$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation vale quick-start.rst
115115
```

0 commit comments

Comments
 (0)