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

doc: add links and style fixes

Browse Source
This commit is contained in:
pancho horrillo
2019-12-13 16:03:49 +01:00
parent 74d9129d27
commit 3149554ff1
1 changed files with 18 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/concepts/routes.rst
+18 -23
View File
@@ -4,7 +4,7 @@ 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 `HTTP User Interface`, and the details to handle it. the :ref:`http-user-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.
@@ -66,34 +66,32 @@ assigning `joe` to the placeholder ``username``.
https://github.com/gorilla/mux#examples https://github.com/gorilla/mux#examples
.. _entrypoint-route-element:
``entrypoint`` Route Element ``entrypoint`` Route Element
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This sets the executable to be spawned, along with any arguments required. This sets the executable to be spawned, along with any arguments required.
In the route shown above, the entrypoint that will be run is ``/bin/bash -c``, In the route shown above, the entrypoint that will be run is ``/bin/bash -c``,
which is an incomplete recipe. It is then completed by the `command` element. which is an incomplete recipe. It is then completed by the :ref:`command
element <command-route-element>`.
.. todo::
link to command below
.. note:: .. note::
The semantics of this element closely match `Docker`'s ``ENTRYPOINT`` directive. The semantics of this element closely match the `Dockerfile`'s `ENTRYPOINT`_
directive.
.. todo::
link to Docker docu
.. _command-route-element:
``command`` Route Element ``command`` Route Element
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
This is an optional last argument to be passed to the ``entrypoint``. This is an optional last argument to be passed to the
:ref:`entrypoint <entrypoint-route-element>`.
In the route shown above, it completes the `entrypoint` to form the final In the route shown above, it completes the ``entrypoint`` to form the final
incantation to be executed: incantation to be executed:
.. todo:: .. todo::
@@ -106,20 +104,17 @@ incantation to be executed:
.. note:: .. note::
The semantics of this element closely match `Docker`'s ``COMMAND`` directive. The semantics of this element closely match the `Dockerfile`'s `CMD`_
directive.
.. todo::
link to Docker docu
Matching Algorithm Matching Algorithm
------------------ ------------------
*Kapow!* leverages Gorilla Mux for this task. You can see the gory details in *Kapow!* leverages `Gorilla Mux`_ for this task. Check their documentation for
their documentation. the gory details.
.. todo:: .. _ENTRYPOINT: https://docs.docker.com/engine/reference/builder/#entrypoint
.. _CMD: https://docs.docker.com/engine/reference/builder/#cmd
link to Gorilla Mux docu .. _Gorilla Mux: https://www.gorillatoolkit.org/pkg/mux