Dark-Alex-17/kapow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: markup :any: role as default role, which is now :tech: (custom)

Browse Source 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
This commit is contained in:
pancho horrillo
2019-12-11 15:59:27 +01:00
parent d7f4293d15
commit ab615e2276
9 changed files with 33 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/concepts/interfaces.rst
+3 -3
View File
@@ -8,7 +8,7 @@ clear purpose.
User Interface
--------------
The :any:`User HTTP Interface` is used to serve final user requests.
The `User HTTP Interface` is used to serve final user requests.
By default it binds to address ``0.0.0.0`` and port ``8080``, but that can be
changed via the ``--bind`` flag.
@@ -17,7 +17,7 @@ changed via the ``--bind`` flag.
Control Interface
-----------------
The :any:`Control HTTP Interface` is used by the command ``kapow route`` to
The `Control HTTP Interface` is used by the command ``kapow route`` to
administer the list of system routes.
By default it binds to address ``127.0.0.1`` and port ``8081``, but that can be
@@ -27,7 +27,7 @@ changed via the ``--control-bind`` flag.
Data Interface
--------------
The :any:`Data HTTP Interface` is used by the commands ``kapow get`` and ``kapow
The `Data HTTP Interface` is used by the commands ``kapow get`` and ``kapow
set`` to exchange the data for a particular request.
By default it binds to address ``127.0.0.1`` and port ``8082``, but that can be
docs/source/concepts/philosophy.rst
+1 -1
View File
@@ -7,7 +7,7 @@ Single Static Binary
- Deployment is then as simple as it gets.
- :any:`Docker`-friendly.
- `Docker`-friendly.
Shell Agnostic
docs/source/concepts/request_life_cycle.rst
+4 -4
View File
@@ -2,7 +2,7 @@ Request Life Cycle
==================
This section describes the sequence of events happening for each request
answered by the :any:`User HTTP Interface`.
answered by the `User HTTP Interface`.
.. image:: ../_static/request_life_cycle.png
@@ -10,7 +10,7 @@ answered by the :any:`User HTTP Interface`.
1. request
----------
The user makes a request to the :any:`User HTTP Interface`.
The user makes a request to the `User HTTP Interface`.
- The request is matched against the route table.
@@ -30,8 +30,8 @@ The spawned entrypoint is run with the following variables added to its
environment:
- :envvar:`KAPOW_HANDLER_ID`: Containing the `HANDLER_ID`
- :envvar:`KAPOW_DATAAPI_URL`: With the URL of the :any:`Data HTTP Interface`
- :envvar:`KAPOW_CONTROLAPI_URL`: With the URL of the :any:`Control HTTP Interface`
- :envvar:`KAPOW_DATAAPI_URL`: With the URL of the `Data HTTP Interface`
- :envvar:`KAPOW_CONTROLAPI_URL`: With the URL of the `Control HTTP Interface`
3. ``kapow set /response/body banana``
docs/source/concepts/routes.rst
+3 -3
View File
@@ -2,7 +2,7 @@ Routes
======
A *Kapow!* route specifies the matching criteria for an incoming request on
the :any:`User HTTP Interface`, and the details to handle it.
the `User HTTP Interface`, and the details to handle it.
*Kapow!* implements a *route table* where all routes reside.
@@ -79,7 +79,7 @@ which is an incomplete recipe. It is then completed by the `command` element.
.. note::
The semantics of this element closely match :any:`Docker`'s ``ENTRYPOINT`` directive.
The semantics of this element closely match `Docker`'s ``ENTRYPOINT`` directive.
.. todo::
@@ -104,7 +104,7 @@ incantation to be executed:
.. note::
The semantics of this element closely match :any:`Docker`'s ``COMMAND`` directive.
The semantics of this element closely match `Docker`'s ``COMMAND`` directive.
.. todo::