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

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
This commit is contained in:
pancho horrillo
2019-12-10 10:34:39 +01:00
parent 7dc1d5db21
commit bb4aa1a00f
17 changed files with 78 additions and 78 deletions
+2 -2
View File
@@ -1,5 +1,5 @@
Kapow! HTTP Interfaces
======================
*Kapow!* HTTP Interfaces
========================
`kapow server` sets up three HTTP server interfaces, each with a distinct and
clear purpose.
+3 -3
View File
@@ -13,7 +13,7 @@ Single Static Binary
Shell Agnostic
--------------
- Kapow! knows nothing, and makes no assumptions, about the shell you are using.
- *Kapow!* knows nothing, and makes no assumptions, about the shell you are using.
It only spawns executables.
- You are free to implement a client to the Data API directly if you are so
@@ -23,9 +23,9 @@ Shell Agnostic
Not a Silver Bullet
-------------------
You should not use Kapow! if your project requires complex business logic.
You should not use *Kapow!* if your project requires complex business logic.
If you try to encode business logic in a shell script, you will **deeply**
regret it.
Kapow! is designed for automating simple stuff.
*Kapow!* is designed for automating simple stuff.
+2 -2
View File
@@ -1,7 +1,7 @@
The `Kapow!` Resource Tree
The *Kapow!* Resource Tree
==========================
This is the model that Kapow! uses to expose the internals of the user request
This is the model that *Kapow!* uses to expose the internals of the user request
being serviced.
+1 -1
View File
@@ -1,7 +1,7 @@
Route Matching
==============
Kapow! maintains a route table with a list of routes as provided by the user,
*Kapow!* maintains a route table with a list of routes as provided by the user,
and uses it to determine which handler should an incoming request be dispatched
to.
+5 -5
View File
@@ -1,10 +1,10 @@
Routes
======
A Kapow! route specifies the matching criteria for an incoming request on
A *Kapow!* route specifies the matching criteria for an incoming request on
the `User HTTP Interface`, and the details to handle it.
Kapow! implements a *route table* where all routes reside.
*Kapow!* implements a *route table* where all routes reside.
A route can be set like this:
@@ -39,7 +39,7 @@ Uniquely identifies each route. It is used for instance by ``kapow route remove
.. note::
The current implementation of Kapow! autogenerates a `UUID` for this field.
The current implementation of *Kapow!* autogenerates a `UUID` for this field.
In the future the use will be able to specify a custom value.
@@ -61,7 +61,7 @@ It can contain regex placeholders for easily capturing fragments of the path.
In the route shown above, a request with a URL ``/register/joe`` would match,
assigning `joe` to the placeholder ``username``.
Kapow! leverages Gorilla Mux for managing routes. For the full story, see
*Kapow!* leverages Gorilla Mux for managing routes. For the full story, see
https://github.com/gorilla/mux#examples
@@ -115,7 +115,7 @@ incantation to be executed:
Matching Algorithm
------------------
`Kapow!` leverages Gorilla Mux for this task. You can see the gory details in
`*Kapow!*` leverages Gorilla Mux for this task. You can see the gory details in
their documentation.