From df50b45e2322d2fb714e5446624d52ba76896970 Mon Sep 17 00:00:00 2001 From: andrew Date: Thu, 9 Aug 2018 13:23:59 -0400 Subject: DOCS: General cleanup (did not move any sections) Change-Id: I67cc42769661c10d2793f8c6cdb3b232b803d145 Signed-off-by: andrew --- docs/gettingstarted/users/installing/index.rst | 2 ++ docs/gettingstarted/writingdocs/index.rst | 15 +++++---- .../writingdocs/styleguide/index.rst | 13 ++++---- .../writingdocs/styleguidemd/index.rst | 7 ++-- docs/usecases/Routing.rst | 30 ++++++++--------- docs/usecases/containerCreation.rst | 38 ++++++++++++---------- docs/usecases/containerSetup.rst | 8 ++--- 7 files changed, 60 insertions(+), 53 deletions(-) diff --git a/docs/gettingstarted/users/installing/index.rst b/docs/gettingstarted/users/installing/index.rst index 6cadae0a314..4a8ac7a6952 100644 --- a/docs/gettingstarted/users/installing/index.rst +++ b/docs/gettingstarted/users/installing/index.rst @@ -2,6 +2,8 @@ .. toctree:: +.. _installingVPP: + Installing VPP from Packages ============================== diff --git a/docs/gettingstarted/writingdocs/index.rst b/docs/gettingstarted/writingdocs/index.rst index 1361c422af7..89245ef28d1 100644 --- a/docs/gettingstarted/writingdocs/index.rst +++ b/docs/gettingstarted/writingdocs/index.rst @@ -14,11 +14,12 @@ This section covers the following topics: .. toctree:: + :maxdepth: 2 - buildingrst - gitreview - readthedocs - styleguide/index.rst - styleguidemd/index.rst - todo - pushingapatch + buildingrst + gitreview + readthedocs + styleguide/index.rst + styleguidemd/index.rst + todo + pushingapatch diff --git a/docs/gettingstarted/writingdocs/styleguide/index.rst b/docs/gettingstarted/writingdocs/styleguide/index.rst index 79d28c37493..443476f83b6 100644 --- a/docs/gettingstarted/writingdocs/styleguide/index.rst +++ b/docs/gettingstarted/writingdocs/styleguide/index.rst @@ -21,10 +21,11 @@ A **Table of Contents** structure is shown below. Using **toctree** in this way in a nicely in the generated documents. .. toctree:: + :maxdepth: 2 - styleguide.rst - styleguide02.rst - styleguide02table.rst - styleguide03.rst - styleguide04.rst - styleguide05.rst + styleguide.rst + styleguide02.rst + styleguide02table.rst + styleguide03.rst + styleguide04.rst + styleguide05.rst diff --git a/docs/gettingstarted/writingdocs/styleguidemd/index.rst b/docs/gettingstarted/writingdocs/styleguidemd/index.rst index 5bafb4d1512..f9dfbeb2dbb 100644 --- a/docs/gettingstarted/writingdocs/styleguidemd/index.rst +++ b/docs/gettingstarted/writingdocs/styleguidemd/index.rst @@ -9,7 +9,8 @@ written in Markdown. This chapter describes some constructs used to write these For a more detailed description of Markdown refer to `Markdown Wikipedia `_ .. toctree:: + :maxdepth: 2 - styleguide.md - styleguide02.md - styleguide03.md + styleguide.md + styleguide02.md + styleguide03.md diff --git a/docs/usecases/Routing.rst b/docs/usecases/Routing.rst index cecc2637108..0c5908fd57e 100644 --- a/docs/usecases/Routing.rst +++ b/docs/usecases/Routing.rst @@ -9,7 +9,7 @@ Now for connecting these two linux containers to VPP and pinging between them. Enter container *cone*, and check the current network configuration: -.. code-block:: shell +.. code-block:: console root@cone:/# ip -o a 1: lo inet 127.0.0.1/8 scope host lo\ valid_lft forever preferred_lft forever @@ -24,7 +24,7 @@ Notice that *veth_link1* has no assigned IP. Check if the interfaces are down or up: -.. code-block:: shell +.. code-block:: console root@cone:/# ip link 1: lo: mtu 65536 qdisc noqueue state UNKNOWN mode DEFAULT group default qlen 1 @@ -42,7 +42,7 @@ Check if the interfaces are down or up: Make sure your loopback interface is up, and assign an IP and gateway to veth_link1. -.. code-block:: shell +.. code-block:: console root@cone:/# ip link set dev lo up root@cone:/# ip addr add 172.16.1.2/24 dev veth_link1 @@ -54,7 +54,7 @@ Here, the IP is 172.16.1.2/24 and the gateway is 172.16.1.1. Run some commands to verify the changes: -.. code-block:: shell +.. code-block:: console root@cone:/# ip -o a 1: lo inet 127.0.0.1/8 scope host lo\ valid_lft forever preferred_lft forever @@ -77,7 +77,7 @@ Now exit this container and repeat this process with container *ctwo*, except wi After thats done for *both* containers, exit from the container if you're in one: -.. code-block:: shell +.. code-block:: console root@ctwo:/# exit exit @@ -85,7 +85,7 @@ After thats done for *both* containers, exit from the container if you're in one In the machine running the containers, run **ip link** to see the host *veth* network interfaces, and their link with their respective *container veth's*. -.. code-block:: shell +.. code-block:: console root@localhost:~# ip link 1: lo: mtu 65536 qdisc noqueue state DOWN mode DEFAULT group default qlen 1 @@ -112,7 +112,7 @@ Remember our network interface index 32 in *cone* from this :ref:`note `_ you may find useful: - .. code-block:: shell + .. code-block:: console - sudo lxc-ls --fancy - sudo lxc-start --name u1 --daemon - sudo lxc-info --name u1 - sudo lxc-stop --name u1 - sudo lxc-destroy --name u1 + $ sudo lxc-ls --fancy + $ sudo lxc-start --name u1 --daemon + $ sudo lxc-info --name u1 + $ sudo lxc-stop --name u1 + $ sudo lxc-destroy --name u1 diff --git a/docs/usecases/containerSetup.rst b/docs/usecases/containerSetup.rst index d1c230daf24..e0fd81eebc3 100644 --- a/docs/usecases/containerSetup.rst +++ b/docs/usecases/containerSetup.rst @@ -9,14 +9,14 @@ Now we can go into container *cone* and install prerequisites such as VPP, and p To enter our container via the shell, type: -.. code-block:: shell +.. code-block:: console # lxc-attach -n cone root@cone:/# Run the linux DHCP setup and install VPP: -.. code-block:: shell +.. code-block:: console root@cone:/# resolvconf -d eth0 root@cone:/# dhclient @@ -28,13 +28,13 @@ Run the linux DHCP setup and install VPP: After this is done, start VPP in this container: -.. code-block:: shell +.. code-block:: console root@cone:/# service vpp start Exit this container with the **exit** command (you *may* need to run **exit** twice): -.. code-block:: shell +.. code-block:: console root@cone:/# exit exit -- cgit 1.2.3-korg