From 1cb328646e8a4c7878c8acfc423ad6010cc2faa9 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Wed, 11 Dec 2019 12:16:41 +0100 Subject: [PATCH] doc: markup ping as 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 | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst index 17f91f2..ca11cae 100644 --- a/docs/source/examples/index.rst +++ b/docs/source/examples/index.rst @@ -482,7 +482,7 @@ In this example we'll redirect our users to Google: How to Execute Two Processes in Parallel ++++++++++++++++++++++++++++++++++++++++ -We want to ``ping`` two machines parallel. *Kapow!* can get IPs from query +We want to :program:`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 10ade49..cc32f78 100644 --- a/docs/source/the_project/quickstart.rst +++ b/docs/source/the_project/quickstart.rst @@ -40,9 +40,9 @@ The Desired Solution -------------------- After analyzing the problem and with our goal in mind, we conclude that it -is enough **to use a simple** ``ping`` **to** ``Internal Host``. +is enough to use a simple :program:`ping` to ``Internal Host``. -So, the next step is to **analyze how to perform the ping.** +So, the next step is to analyze how to perform the :program:`ping`. Accessing via SSH to ``External Host`` @@ -58,7 +58,7 @@ Reasons: 1. We need to manage users (violates a constraint.) 2. We need to grant usesrs access to a host (violates a constraint.) - 3. We can't control what ``ping`` options the user can use to ping ``Internal Host`` (violates a constraint.) + 3. We can't control what :program:`ping` options the user can use to ping ``Internal Host`` (violates a constraint.) Develop and Deploy a Custom Solution @@ -130,9 +130,9 @@ Explanation: endpoint. 2. ``-c`` - after this parameter we write the system command that *Kapow!* will run each time the endpoint is invoked. -3. ``ping -c 1 10.10.10.100`` - sends 1 ping package to the host +3. ``ping -c 1 10.10.10.100`` - sends 1 ping packet to the host *10.10.10.100*, i.e. ``Internal Host``. -4. ``| kapow set /response/body`` - writes the output of `ping` to the body +4. ``| kapow set /response/body`` - writes the output of :program:`ping` to the body of the response, so you can see it.