summaryrefslogtreecommitdiff
path: root/docs/contributing/documentation.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-11-27 17:20:36 +0100
committerChristian Poessinger <christian@poessinger.com>2019-11-27 17:20:38 +0100
commit6aa3cbb611f74bdf8e44d5527f5138f3122a7497 (patch)
tree009a1fe9447bdd980d5017d49f102e7ccdace03b /docs/contributing/documentation.rst
parent76bbe2744d7184ee50626d9d7b65f21dad1c7e99 (diff)
downloadvyos-documentation-6aa3cbb611f74bdf8e44d5527f5138f3122a7497.tar.gz
vyos-documentation-6aa3cbb611f74bdf8e44d5527f5138f3122a7497.zip
Refactor "code-block:: sh" to "code-block:: console"
This will add proper new-lines into the rendered PDF. Before if it has been a long line, not all content was preserved in the PDF.
Diffstat (limited to 'docs/contributing/documentation.rst')
-rw-r--r--docs/contributing/documentation.rst8
1 files changed, 4 insertions, 4 deletions
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