summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorerkin <e.altunbas@vyos.io>2021-01-23 14:49:32 +0300
committererkin <e.altunbas@vyos.io>2021-01-23 14:49:32 +0300
commit01b935d0461fc461f4070c805d0cde7ca8a5cba4 (patch)
tree5d8dfcb8648a2d8bcaa96d686e16812af17677fd /README.md
parentc696c0ab337924c9322849d0ca0748c4601299bc (diff)
downloadvyos-documentation-01b935d0461fc461f4070c805d0cde7ca8a5cba4.tar.gz
vyos-documentation-01b935d0461fc461f4070c805d0cde7ca8a5cba4.zip
Fix typos in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 16 insertions, 16 deletions
diff --git a/README.md b/README.md
index bd96d7cd..15059831 100644
--- a/README.md
+++ b/README.md
@@ -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:
* https://docs.vyos.io
@@ -9,9 +9,9 @@ to ReadTheDocs. Documentation can be accessed via the following URL:
## 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
Required Debian Packages:
@@ -22,28 +22,28 @@ Required Debian Packages:
* `sphinx`
### sphinx
-Debian, requires some extra steps for
+Debian requires some extra steps for
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
python --version
```
-Alternatively, to make python3 the default, revise the following line to
-point to the relevant 3.x version of the binary on your system:
+Alternatively, to make Python the default, revise the following line to
+point at the relevant 3.x version of the binary on your system:
```bash
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
sudo apt-get install python3-sphinx
```
-Although mostly everything uses phython3, But to install this specific
-package, make sure that pip points to the python2 version of the package manager:
+Although almost everything uses Python 3, in order to install this specific
+package, make sure that pip points at the Python 2 version of the package manager:
```bash
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
Then, to view the live output:
* 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.
## 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.
## 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.
```bash
$ 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
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 .
```
-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) \