diff options
| author | Christian Poessinger <christian@poessinger.com> | 2019-10-16 15:33:01 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-16 15:33:01 +0200 |
| commit | 9982023728283b6212bf8820f8634a10c1764317 (patch) | |
| tree | 50213104350fdd50b78c8c3e4c03019c8bc9c266 /README.md | |
| parent | d5400cd2822539c2e0a1416fa728b942a3cb1b9f (diff) | |
| parent | d59ccf6c896c7ae5a5604bc66d79357584745f79 (diff) | |
| download | vyos-documentation-9982023728283b6212bf8820f8634a10c1764317.tar.gz vyos-documentation-9982023728283b6212bf8820f8634a10c1764317.zip | |
Merge pull request #130 from rebortg/vale
T1731: 1st version to test vale
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
@@ -58,3 +58,17 @@ docker run --rm -it -v "$(pwd):/vyos" -w /vyos/docs vyos-docu make html docker run --rm -it -p 8000:8000 -v "$(pwd):/vyos" -w /vyos/docs vyos-docu make livehtml ``` +### Test the docs + +discuss in this Task: [T1731](https://phabricator.vyos.net/T1731) + +to test all files: + +```bash +$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos-docu vale . +``` + +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 +``` |