From b7efb3f109d39bcfd037f934658af63c6e264577 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roberto=20Abdelkader=20Mart=C3=ADnez=20P=C3=A9rez?= Date: Wed, 20 Nov 2019 13:37:20 +0100 Subject: [PATCH] Documentation typos and improvements. Thanks Noel! --- docs/source/theory/interfaces.rst | 10 +++++----- docs/source/theory/request_life_cycle.rst | 13 +++++++------ docs/source/theory/resource_tree.rst | 4 ++-- 3 files changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/source/theory/interfaces.rst b/docs/source/theory/interfaces.rst index d26ea87..d09c92d 100644 --- a/docs/source/theory/interfaces.rst +++ b/docs/source/theory/interfaces.rst @@ -9,7 +9,7 @@ User Interface 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 can be changed via +By default it binds to address ``0.0.0.0`` and port ``8080``, but can be changed via the ``--bind`` flag. @@ -19,15 +19,15 @@ Control Interface 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 can be changed +By default it binds to address ``127.0.0.1`` and port ``8081``, but can be changed via the ``--control-bind`` flag. Data Interface -------------- -The Data HTTP interface is used by the commands `kapow get` and `kapow -set` to exchange the data for a particular request. +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 can be changed +By default it binds to address ``127.0.0.1`` and port ``8082``, but can be changed via the ``--data-bind`` flag. diff --git a/docs/source/theory/request_life_cycle.rst b/docs/source/theory/request_life_cycle.rst index 0ca5643..086386a 100644 --- a/docs/source/theory/request_life_cycle.rst +++ b/docs/source/theory/request_life_cycle.rst @@ -14,15 +14,16 @@ answered by the User HTTP Interface. The default entrypoint is /bin/sh; we'll explain this workflow for now. - The spawned entrypoint is run with following variables added to its environment: -- KAPOW_HANDLER_ID -- KAPOW_DATAAPI_URL -- KAPOW_CONTROLAPI_URL + The spawned entrypoint is run with the following variables added to its environment: + + - KAPOW_HANDLER_ID + - KAPOW_DATAAPI_URL + - KAPOW_CONTROLAPI_URL #. During the lifetime of the shell, the request and response resources are available via these commands: -- kapow get /request/... -- kapow set /response/... + - kapow get /request/... + - kapow set /response/... TODO: link to resource tree diff --git a/docs/source/theory/resource_tree.rst b/docs/source/theory/resource_tree.rst index 4fcf91e..36ec0be 100644 --- a/docs/source/theory/resource_tree.rst +++ b/docs/source/theory/resource_tree.rst @@ -1,5 +1,5 @@ -The Resource Tree -================= +The `Kapow!` Resource Tree +========================== This is the model that Kapow! uses to expose the internals of the user request being serviced.