vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix typos in README

Browse Source
This commit is contained in:
erkin 2021-01-23 14:49:32 +03:00
parent c696c0ab33
commit 01b935d046
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,4 +1,4 @@
Starting with VyOS 1.2 (`crux`) documentation will be migrated from the old wiki Starting with VyOS 1.2 (`crux`) documentation is being migrated from the old wiki
to ReadTheDocs. Documentation can be accessed via the following URL: to ReadTheDocs. Documentation can be accessed via the following URL:
* https://docs.vyos.io * https://docs.vyos.io
@ -9,9 +9,9 @@ to ReadTheDocs. Documentation can be accessed via the following URL:
## Native ## Native
To build the manual run the following commands inside the `docs` folder: To build the manual, run the following commands inside the `docs` folder:
* `make html` for a HTML manual * `make html` for an HTML manual
* `make latexpdf` for a LaTeX rendered PDF * `make latexpdf` for a LaTeX rendered PDF
Required Debian Packages: Required Debian Packages:
@ -22,28 +22,28 @@ Required Debian Packages:
* `sphinx` * `sphinx`
### sphinx ### sphinx
Debian, requires some extra steps for Debian requires some extra steps for
installing `sphinx`, `sphinx-autobuild` and `sphinx-rtd-theme` packages: installing `sphinx`, `sphinx-autobuild` and `sphinx-rtd-theme` packages:
First ensure that phython2 & phython3 are installed and phython3 is the default: First ensure that Python 2 & Python 3 are installed and Python 3 is the default:
```bash ```bash
python --version python --version
``` ```
Alternatively, to make python3 the default, revise the following line to Alternatively, to make Python the default, revise the following line to
point to the relevant 3.x version of the binary on your system: point at the relevant 3.x version of the binary on your system:
```bash ```bash
sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 0 sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 0
``` ```
Then follow these steps to install sphinx group of packages: Then install the sphinx group of packages:
```bash ```bash
sudo apt-get install python3-sphinx sudo apt-get install python3-sphinx
``` ```
Although mostly everything uses phython3, But to install this specific Although almost everything uses Python 3, in order to install this specific
package, make sure that pip points to the python2 version of the package manager: package, make sure that pip points at the Python 2 version of the package manager:
```bash ```bash
python --version python --version
@ -56,29 +56,29 @@ sudo pip install sphinx-rtd-theme
``` ```
Do the following to build the html and start a webeserver: Do the following to build the HTML and start a webserver:
* Run `make livehtml` inside the `docs` folder * Run `make livehtml` inside the `docs` folder
Then, to view the live output: Then, to view the live output:
* Browse to http://localhost:8000 * Browse to http://localhost:8000
Note: The changes you save to the sources are represented in the live HTML outout Note: The changes you save to the sources are represented in the live HTML output
automatically (and almost instantly) without the need to rebuild or refresh manually. automatically (and almost instantly) without the need to rebuild or refresh manually.
## Docker ## Docker
Using our [Dockerfile](docker/Dockerfile) you create your own Docker container Using our [Dockerfile](docker/Dockerfile) you can create your own Docker container
that is used to build a VyOS documentation. that is used to build a VyOS documentation.
## Setup ## Setup
You can either build the container on your own or directly fetch it prebuild You can either build the container on your own or directly fetch it prebuilt
from Dockerhub. If you want to build it for yourself, use the following command. from Dockerhub. If you want to build it for yourself, use the following command.
```bash ```bash
$ docker build -t vyos/vyos-documentation docker $ docker build -t vyos/vyos-documentation docker
``` ```
### Build documentation ### Building documentation
If the `vyos/vyos-documentation` container could not be found locally it will be If the `vyos/vyos-documentation` container could not be found locally it will be
automatically fetched from Dockerhub. automatically fetched from Dockerhub.
@ -103,7 +103,7 @@ $ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs \
-e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation vale . -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 ```bash
$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) \ $ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) \