From 908f5db1edc5c36fabcf1187dbc8a1263b5d5492 Mon Sep 17 00:00:00 2001 From: Arthur Degonde <44548105+ArthurD1@users.noreply.github.com> Date: Fri, 29 Mar 2024 17:35:16 +0100 Subject: [PATCH] update docs --- docs/faq.rst | 2 +- docs/features/alerting.rst | 1 + docs/features/basics.rst | 4 +++- docs/features/batching.rst | 3 +++ docs/features/caching.rst | 3 ++- docs/features/configuration.rst | 2 ++ docs/features/intelligence.rst | 2 ++ docs/features/normalization-and-typing.rst | 2 ++ docs/features/prefetching.rst | 2 ++ docs/features/retrying.rst | 2 ++ docs/features/rewriting.rst | 2 ++ docs/features/routing.rst | 2 ++ docs/quickstart/index.rst | 5 +++-- harp_apps/dashboard/docs/development/testing.rst | 4 ---- 14 files changed, 27 insertions(+), 9 deletions(-) delete mode 100644 harp_apps/dashboard/docs/development/testing.rst diff --git a/docs/faq.rst b/docs/faq.rst index a0e80e83..24683254 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -48,6 +48,6 @@ interface subpackage. Try running the following command: - (cd vendors/mkui; pnpm exec playwright install) + (cd harp_apps/dashboard/frontend; pnpm exec playwright install) It should download the expected browser versions in your local cache, allowing to run the interface tests. diff --git a/docs/features/alerting.rst b/docs/features/alerting.rst index ffbcb9fa..8548c0cd 100644 --- a/docs/features/alerting.rst +++ b/docs/features/alerting.rst @@ -1,2 +1,3 @@ Alerting ======== +.. TODO remove or elaborate about the overview, maybe rename in monitoring diff --git a/docs/features/basics.rst b/docs/features/basics.rst index 90932eca..d701a398 100644 --- a/docs/features/basics.rst +++ b/docs/features/basics.rst @@ -8,7 +8,7 @@ alerting, retrying...). You can read more about the core HTTP proxy features in the :doc:`http-proxy` section of the documentation. By default, it respects HTTP cache headers and will speed up your API calls without further configuration. Of course, -a lot of APIs are non-standard or bahve strangely, and one goal of HARP is to give you a toolkit for fixing those. +a lot of APIs are non-standard or behave strangely, and one goal of HARP is to give you a toolkit for fixing those. Most usually complex but must-have features can be configured using very few lines of code (most often one or less), and you can extend the existing or write your own using Python or Cython (for incredible speed and efficience, if @@ -21,6 +21,7 @@ You run it locally, and query the local server instead of the remote API. The easiest way to get started is to run it through docker: +.. # TO DO update this with a working command for docker .. code-block:: bash docker run -it --rm -p 4000:4000 -p 4080:4080 -e HARP_ENDPOINT_URL=https://httpbin.org makersquad/harp-proxy @@ -47,6 +48,7 @@ configure it using its python API and/or a configuration file (various formats a Here is a simple example of a bootstrap script that will do the exact same thing as the docker command above: +.. TODO This is outdated, I don't think it exists anymore. .. code-block:: python from harp import ProxyFactory diff --git a/docs/features/batching.rst b/docs/features/batching.rst index 030c11e3..89bde7a8 100644 --- a/docs/features/batching.rst +++ b/docs/features/batching.rst @@ -1,2 +1,5 @@ Batching ======== + +.. todo:: + remove? diff --git a/docs/features/caching.rst b/docs/features/caching.rst index a713ffb5..f1fdd62d 100644 --- a/docs/features/caching.rst +++ b/docs/features/caching.rst @@ -1,4 +1,5 @@ Caching ======= - +.. todo:: + remove or elaborate? Gentle, Strict, Stale-While-Revalidate ... diff --git a/docs/features/configuration.rst b/docs/features/configuration.rst index 6e79ebdf..debe9e72 100644 --- a/docs/features/configuration.rst +++ b/docs/features/configuration.rst @@ -1,2 +1,4 @@ Configuration ============= +.. todo:: + remove? diff --git a/docs/features/intelligence.rst b/docs/features/intelligence.rst index 943aba68..6262e6e5 100644 --- a/docs/features/intelligence.rst +++ b/docs/features/intelligence.rst @@ -1,2 +1,4 @@ Intelligence ============ +.. todo:: + remove? diff --git a/docs/features/normalization-and-typing.rst b/docs/features/normalization-and-typing.rst index 0f4b9d08..00a0e19b 100644 --- a/docs/features/normalization-and-typing.rst +++ b/docs/features/normalization-and-typing.rst @@ -1,2 +1,4 @@ Normalization and Typing ======================== +.. todo:: + remove? diff --git a/docs/features/prefetching.rst b/docs/features/prefetching.rst index 1f44a034..5c779e04 100644 --- a/docs/features/prefetching.rst +++ b/docs/features/prefetching.rst @@ -1,2 +1,4 @@ Prefetching =========== +.. todo:: + remove? diff --git a/docs/features/retrying.rst b/docs/features/retrying.rst index d02598d0..84fde866 100644 --- a/docs/features/retrying.rst +++ b/docs/features/retrying.rst @@ -1,2 +1,4 @@ Retrying ======== +.. todo:: + remove? diff --git a/docs/features/rewriting.rst b/docs/features/rewriting.rst index 66e1ea85..53534648 100644 --- a/docs/features/rewriting.rst +++ b/docs/features/rewriting.rst @@ -1,2 +1,4 @@ Rewriting ========= +.. todo:: + remove? diff --git a/docs/features/routing.rst b/docs/features/routing.rst index 7750915c..6e21e9a4 100644 --- a/docs/features/routing.rst +++ b/docs/features/routing.rst @@ -1,2 +1,4 @@ Routing ======= +.. todo:: + remove? diff --git a/docs/quickstart/index.rst b/docs/quickstart/index.rst index a7410c02..baad6afd 100644 --- a/docs/quickstart/index.rst +++ b/docs/quickstart/index.rst @@ -9,6 +9,7 @@ The easiest way to run it is to use our docker image. It is available on docker .. tab-set-code:: + .. code-block:: docker # TODO review needed (config format updated since written) @@ -20,7 +21,7 @@ The easiest way to run it is to use our docker image. It is available on docker makersquad/harp-proxy:latest .. code-block:: compose - + # Should we provide a basic yaml file? $ cat < docker-compose.yml version: '3' @@ -39,7 +40,7 @@ The easiest way to run it is to use our docker image. It is available on docker $ docker compose up -d .. note:: - + # The doc from all the installation methods don't exist yet, even the ones that exist. Other installation options exist but are out of the scope of this quick start guide. You can read more about :doc:`installing with docker <../installation/docker>`, :doc:`installing with docker diff --git a/harp_apps/dashboard/docs/development/testing.rst b/harp_apps/dashboard/docs/development/testing.rst deleted file mode 100644 index 2246969a..00000000 --- a/harp_apps/dashboard/docs/development/testing.rst +++ /dev/null @@ -1,4 +0,0 @@ -Tests -===== - -Frontend tests are written