doc: normalize style of Kapow!, to be shown italicized

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-10 10:34:39 +01:00
parent 7dc1d5db21
commit bb4aa1a00f
17 changed files with 78 additions and 78 deletions
@@ -1,13 +1,13 @@
-Kapow! Tutorial
-===============
+*Kapow!* Tutorial
+=================

-  This tutorial will allow you to grow slowly in the knowledge of Kapow!.  It
+  This tutorial will allow you to grow slowly in the knowledge of *Kapow!*.  It
  tells you the story of a senior ops guy just arrived to his new job in a small
  company.  He'll face different challenges of increasing difficulty, but with
-  the help of his experienced senior mate and Kapow! he will be able to satisfy
+  the help of his experienced senior mate and *Kapow!* he will be able to satisfy
  all the requierements.

  You just only need to follow the steps and execute the code shown in the
-  tutorial to learn the Kapow! way of doing.
+  tutorial to learn the *Kapow!* way of doing.

  Have a nice trip to Kapow!
@@ -78,7 +78,7 @@ Backup that Database!

  Ok then, let's try on your laptop first.

-  First of all you have to follow the `installation instructions </the_project/install_and_configure>`_. 
+  First of all you have to follow the `installation instructions </the_project/install_and_configure>`_.

 **Junior**

@@ -88,9 +88,9 @@ Backup that Database!
 **Senior**

  Don't worry it is pretty easy.  Basically we will provide an HTTP
-  endpoint managed by Kapow! at the **Corporate Server**; when the
+  endpoint managed by *Kapow!* at the **Corporate Server**; when the
  project team wants to perform a backup they only need to call the
-  endpoint and Kapow! will call the backup script.
+  endpoint and *Kapow!* will call the backup script.

 **Junior**

@@ -145,7 +145,7 @@ Backup that Database!
     $ cat backup.pow
     kapow route add -X PUT /db/backup -e ./backup_db.sh

-  And then you can start Kapow! with it:
+  And then you can start *Kapow!* with it:

  .. code-block:: console

@@ -11,7 +11,7 @@ What we've done?

 **Junior**

-  Makes sense.  Do you think that Kapow! can help with this? I feel that this is
+  Makes sense.  Do you think that *Kapow!* can help with this? I feel that this is
  the way to do it.

 **Senior**
@@ -47,7 +47,7 @@ What we've done?
 **Senior**

  Looks good to me, clean and simple, and it is a very good idea to use ``GET``
-  here as it wont change anything in the server. Restart Kapow! and try it.
+  here as it wont change anything in the server. Restart *Kapow!* and try it.

 **Junior**

@@ -19,9 +19,9 @@ We need to filter
 **Senior**

  By sure, but in addition to some good shell plumbing we're going to squeeze
-  Kapow!'s superpowers a litle bit more to get a really good solution.
+  *Kapow!*'s superpowers a litle bit more to get a really good solution.

-  Can you take a look at Kapow!'s documentation to see if something can be done?
+  Can you take a look at *Kapow!*'s documentation to see if something can be done?

 **Junior**

@@ -31,7 +31,7 @@ We need to filter

 **Senior**

-  Sounds great!  How we have lived without Kapow! all this time?
+  Sounds great!  How we have lived without *Kapow!* all this time?

  As they requested, we can offer them with a parameter to filter the registers
  they want to pick and another parameter to limit the output size in lines.
@@ -27,7 +27,7 @@ I Need My Report

  We prepare a report with some statistics about the load of our
  servers.  This way we know when we have to buy another one.
-  
+
 **Junior**

  I see this company scales just like Google.
@@ -58,7 +58,7 @@ I Need My Report

 **Junior**

-  Well, I guess we can make a Kapow! endpoint to let her see all this
+  Well, I guess we can make a *Kapow!* endpoint to let her see all this
  information from the browser.  This way she doesn't need to waste any
  time asking us.

@@ -102,7 +102,7 @@ I Need My Report
     Memory:
     ... the output of `free -m` ...
     ================================================================================
-     ... and so on ... 
+     ... and so on ...

 **Junior**

@@ -136,13 +136,13 @@ I Need My Report
        more than one line
        here
       EOF
-  
+
  The shell will put the data between the first ``EOF`` and the second
  ``EOF`` as the ``stdin`` of the ``cat`` process.

 **Junior**

-  If I want to use this with Kapow! I have to make it read the script
+  If I want to use this with *Kapow!* I have to make it read the script
  from ``stdin``.  To do this I know that I have to put a ``-`` at the
  end.

@@ -85,7 +85,7 @@ Sharing the Stats

 **Junior**

-  Let's use it then! 
+  Let's use it then!

  How can we generate a JSON document with ``jq``?

@@ -157,7 +157,7 @@ Sharing the Stats
     EOF

  What do you think?
-   
+
 **Senior**

  You forgot one more thing.
@@ -196,9 +196,9 @@ Sharing the Stats
  Just a couple of details.

  1. You have to set the headers **before** the body.  This is because the body
-     can be so big that Kapow! is forced to start sending it out.
+     can be so big that *Kapow!* is forced to start sending it out.
  2. In cases where you want to set a small piece of data (like the header) is
-     better to not use the ``stdin``.  Kapow! provides a secondary syntax for these
+     better to not use the ``stdin``.  *Kapow!* provides a secondary syntax for these
     cases:

     .. code-block:: console