diff options
Diffstat (limited to 'docs/contributing')
| -rw-r--r-- | docs/contributing/build-vyos.rst | 8 | ||||
| -rw-r--r-- | docs/contributing/development.rst | 4 | ||||
| -rw-r--r-- | docs/contributing/documentation.rst | 8 |
3 files changed, 10 insertions, 10 deletions
diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index ab9ba6b2..3dbd1310 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -18,7 +18,7 @@ Buster. Installing Docker_ and prerequisites: -.. code-block:: sh +.. code-block:: console $ apt-get update $ apt-get install -y apt-transport-https ca-certificates curl \ @@ -48,7 +48,7 @@ the vyos-build repository). The container can always be built directly from source: -.. code-block:: sh +.. code-block:: console $ git clone -b current --single-branch https://github.com/vyos/vyos-build $ docker build -t vyos/vyos-build docker @@ -68,7 +68,7 @@ Build ISO After the container is generated either manually or fetched from DockerHub, a fresh build of the VyOS ISO can begin. -.. code-block:: sh +.. code-block:: console $ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build bash vyos_bld@d4220bb519a0:/vyos# ./configure --architecture amd64 \ @@ -88,7 +88,7 @@ image: This ISO can be customized with the following list of configure options. The full and current list can be generated with ``./configure --help``: -.. code-block:: sh +.. code-block:: console -h, --help show this help message and exit --architecture ARCHITECTURE diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst index 740646bc..366621a5 100644 --- a/docs/contributing/development.rst +++ b/docs/contributing/development.rst @@ -115,7 +115,7 @@ which of the many VyOS packages ship this file. You can determine the VyOS package name in question by using Debians ``dpkg -S`` command of your running VyOS installation. -.. code-block:: sh +.. code-block:: console vyos@vyos:~ dpkg -S /opt/vyatta/sbin/vyatta-update-webproxy.pl vyatta-webproxy: /opt/vyatta/sbin/vyatta-update-webproxy.pl @@ -144,7 +144,7 @@ In order to record you as the author of the fix please indentify yourself to Git by setting up your name and email. This can be done local for this one and only repository ``git config`` or globally using ``git config --global``. -.. code-block:: sh +.. code-block:: console git config --global user.name "J. Random Hacker" git config --global user.email "jrhacker@example.net" diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index 33803c98..51fe0981 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -59,7 +59,7 @@ This requires you already have a GitHub account. Check your configured remote repositories: - .. code-block:: sh + .. code-block:: console $ git remote -v origin https://github.com/YOUR_USERNAME/vyos-documentation.git (fetch) @@ -70,7 +70,7 @@ This requires you already have a GitHub account. Your remote repo on Github is called Origin, while the original repo you have forked is called Upstream. Now you can locally update your forked repo. - .. code-block:: sh + .. code-block:: console $ git fetch upstream $ git checkout master @@ -88,7 +88,7 @@ Sections We use the following syntax for Headlines. -.. code-block:: sh +.. code-block:: console ##### Parts @@ -139,7 +139,7 @@ Under the command a short exlaination should be provide. Example: -.. code-block:: sh +.. code-block:: console .. opcmd:: show protocols static arp |