From e78af66c128f7eb01ebd36eee9fe302c8c94991e Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Wed, 11 Dec 2019 17:56:28 +0100 Subject: [PATCH] doc: markup ping as command role, not program role MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Roberto Abdelkader Martínez Pérez --- docs/source/examples/index.rst | 2 +- docs/source/the_project/quickstart.rst | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst index 0b8df5c..1e73827 100644 --- a/docs/source/examples/index.rst +++ b/docs/source/examples/index.rst @@ -483,7 +483,7 @@ In this example we'll redirect our users to Google: How to Execute Two Processes in Parallel ++++++++++++++++++++++++++++++++++++++++ -We want to :program:`ping` two machines parallel. *Kapow!* can get IPs from query +We want to :command:`ping` two machines parallel. *Kapow!* can get IPs from query params: .. code-block:: console diff --git a/docs/source/the_project/quickstart.rst b/docs/source/the_project/quickstart.rst index 8738442..fa927ac 100644 --- a/docs/source/the_project/quickstart.rst +++ b/docs/source/the_project/quickstart.rst @@ -44,9 +44,9 @@ The Desired Solution -------------------- After analyzing the problem and with our goal in mind, we conclude that it -is enough to use a simple :program:`ping` to **Internal Host**. +is enough to use a simple :command:`ping` to **Internal Host**. -So, the next step is to analyze how to perform the :program:`ping`. +So, the next step is to analyze how to perform the :command:`ping`. Accessing via SSH to External Host @@ -63,7 +63,7 @@ grant them `ssh` access. #. We'd need to manage users (violates a constraint). #. We'd need to grant users access to a host (violates a constraint). #. We would not be able to control what options the user could provide to - :program:`ping` (violates a constraint). + :command:`ping` (violates a constraint). Develop and Deploy a Custom Solution @@ -140,7 +140,7 @@ Let's dissect this beast piece by piece: will run each time the endpoint is invoked. #. ``ping -c 1 10.10.10.100`` - sends one `ICMP ping packet` to the **Internal Host**. -#. ``| kapow set /response/body`` - writes the output of :program:`ping` to the +#. ``| kapow set /response/body`` - writes the output of :command:`ping` to the body of the response, so you can see it.