docs: refactoring

msqd · Apr 1, 2024 · 5478957 · 5478957
1 parent ee055da
commit 5478957
Show file tree

Hide file tree

Showing 79 changed files with 231 additions and 233 deletions.
diff --git a/docs/_static/css/harp.css b/docs/_static/css/harp.css
@@ -0,0 +1,30 @@
+.jumbo-toc table {
+    border: 2px solid #334155;
+}
+
+.jumbo-toc table td {
+    border: 2px solid #334155;
+    vertical-align: top;
+}
+
+.jumbo-toc table td > p > a:first-child {
+    font-size: 1.2em;
+    font-weight: bold;
+}
+
+.jumbo-toc table ul {
+    margin: 0;
+    padding: 0;
+    list-style-type: none;
+    font-size: 0.9em;
+    display: flex;
+    flex-direction: row;
+    flex-wrap: wrap;
+    justify-content: space-between;
+}
+
+.jumbo-toc table ul li {
+    flex-grow: 1;
+    flex-basis: auto;
+    text-align: center;
+}
diff --git a/docs/apps/index.rst b/docs/apps/index.rst
@@ -0,0 +1,9 @@
+Applications
+============
+
+.. toctree::
+    :maxdepth: 1
+
+    dashboard/index
+    proxy/index
+    sqlalchemy_storage/index
diff --git a/docs/conf.py b/docs/conf.py
@@ -40,6 +40,7 @@
 html_theme = "furo"
 html_static_path = ["_static"]
 html_js_files = ["js/links-target-blank.js"]
+html_css_files = ["css/harp.css"]
 html_baseurl = "https://msqd.github.io/harp/"
 
 html_sidebars = {

diff --git a/...ent/applications/application-protocol.rst → ...ute/applications/application-protocol.rst b/...ent/applications/application-protocol.rst → ...ute/applications/application-protocol.rst
diff --git a/...ent/applications/dependency-injection.rst → ...ute/applications/dependency-injection.rst b/...ent/applications/dependency-injection.rst → ...ute/applications/dependency-injection.rst
diff --git a/...lopment/applications/event-dispatcher.rst → ...tribute/applications/event-dispatcher.rst b/...lopment/applications/event-dispatcher.rst → ...tribute/applications/event-dispatcher.rst
diff --git a/docs/development/applications/index.rst → docs/contribute/applications/index.rst b/docs/development/applications/index.rst → docs/contribute/applications/index.rst
diff --git a/docs/development/benchmarks.rst → docs/contribute/benchmarks.rst b/docs/development/benchmarks.rst → docs/contribute/benchmarks.rst
diff --git a/docs/development/changelogs/0.1.3.rst → docs/contribute/changelogs/0.1.3.rst b/docs/development/changelogs/0.1.3.rst → docs/contribute/changelogs/0.1.3.rst
diff --git a/docs/development/changelogs/0.2.0.rst → docs/contribute/changelogs/0.2.0.rst b/docs/development/changelogs/0.2.0.rst → docs/contribute/changelogs/0.2.0.rst
diff --git a/docs/development/changelogs/0.2.1.rst → docs/contribute/changelogs/0.2.1.rst b/docs/development/changelogs/0.2.1.rst → docs/contribute/changelogs/0.2.1.rst
diff --git a/docs/development/changelogs/0.2.2.rst → docs/contribute/changelogs/0.2.2.rst b/docs/development/changelogs/0.2.2.rst → docs/contribute/changelogs/0.2.2.rst
diff --git a/docs/development/changelogs/0.2.3.rst → docs/contribute/changelogs/0.2.3.rst b/docs/development/changelogs/0.2.3.rst → docs/contribute/changelogs/0.2.3.rst
diff --git a/docs/development/changelogs/0.3.0.rst → docs/contribute/changelogs/0.3.0.rst b/docs/development/changelogs/0.3.0.rst → docs/contribute/changelogs/0.3.0.rst
diff --git a/docs/development/changelogs/0.3.1.rst → docs/contribute/changelogs/0.3.1.rst b/docs/development/changelogs/0.3.1.rst → docs/contribute/changelogs/0.3.1.rst
diff --git a/docs/development/changelogs/0.3.2.rst → docs/contribute/changelogs/0.3.2.rst b/docs/development/changelogs/0.3.2.rst → docs/contribute/changelogs/0.3.2.rst
diff --git a/docs/development/changelogs/0.4.0.rst → docs/contribute/changelogs/0.4.0.rst b/docs/development/changelogs/0.4.0.rst → docs/contribute/changelogs/0.4.0.rst
diff --git a/...hangelogs/benchmarks/0.2.2-postgresql.svg → ...hangelogs/benchmarks/0.2.2-postgresql.svg b/...hangelogs/benchmarks/0.2.2-postgresql.svg → ...hangelogs/benchmarks/0.2.2-postgresql.svg
diff --git a/...nt/changelogs/benchmarks/0.2.2-sqlite.svg → ...te/changelogs/benchmarks/0.2.2-sqlite.svg b/...nt/changelogs/benchmarks/0.2.2-sqlite.svg → ...te/changelogs/benchmarks/0.2.2-sqlite.svg
diff --git a/...hangelogs/benchmarks/0.2.3-postgresql.svg → ...hangelogs/benchmarks/0.2.3-postgresql.svg b/...hangelogs/benchmarks/0.2.3-postgresql.svg → ...hangelogs/benchmarks/0.2.3-postgresql.svg
diff --git a/...nt/changelogs/benchmarks/0.2.3-sqlite.svg → ...te/changelogs/benchmarks/0.2.3-sqlite.svg b/...nt/changelogs/benchmarks/0.2.3-sqlite.svg → ...te/changelogs/benchmarks/0.2.3-sqlite.svg
diff --git a/...hangelogs/benchmarks/0.3.0-postgresql.svg → ...hangelogs/benchmarks/0.3.0-postgresql.svg b/...hangelogs/benchmarks/0.3.0-postgresql.svg → ...hangelogs/benchmarks/0.3.0-postgresql.svg
diff --git a/...nt/changelogs/benchmarks/0.3.0-sqlite.svg → ...te/changelogs/benchmarks/0.3.0-sqlite.svg b/...nt/changelogs/benchmarks/0.3.0-sqlite.svg → ...te/changelogs/benchmarks/0.3.0-sqlite.svg
diff --git a/...hangelogs/benchmarks/0.3.2-postgresql.svg → ...hangelogs/benchmarks/0.3.2-postgresql.svg b/...hangelogs/benchmarks/0.3.2-postgresql.svg → ...hangelogs/benchmarks/0.3.2-postgresql.svg
diff --git a/...nt/changelogs/benchmarks/0.3.2-sqlite.svg → ...te/changelogs/benchmarks/0.3.2-sqlite.svg b/...nt/changelogs/benchmarks/0.3.2-sqlite.svg → ...te/changelogs/benchmarks/0.3.2-sqlite.svg
diff --git a/...hangelogs/benchmarks/0.4.0-postgresql.svg → ...hangelogs/benchmarks/0.4.0-postgresql.svg b/...hangelogs/benchmarks/0.4.0-postgresql.svg → ...hangelogs/benchmarks/0.4.0-postgresql.svg
diff --git a/...nt/changelogs/benchmarks/0.4.0-sqlite.svg → ...te/changelogs/benchmarks/0.4.0-sqlite.svg b/...nt/changelogs/benchmarks/0.4.0-sqlite.svg → ...te/changelogs/benchmarks/0.4.0-sqlite.svg
diff --git a/docs/development/changelogs/containers.rst → docs/contribute/changelogs/containers.rst b/docs/development/changelogs/containers.rst → docs/contribute/changelogs/containers.rst
diff --git a/docs/development/changelogs/index.rst → docs/contribute/changelogs/index.rst b/docs/development/changelogs/index.rst → docs/contribute/changelogs/index.rst
diff --git a/docs/development/ideas.rst → docs/contribute/ideas.rst b/docs/development/ideas.rst → docs/contribute/ideas.rst
diff --git a/docs/contribute/index.rst b/docs/contribute/index.rst
@@ -0,0 +1,21 @@
+Contributor's Guide
+===================
+
+.. toctree::
+    :maxdepth: 2
+
+    introduction
+    extending
+    applications/index
+    storage/index
+    ../apps/dashboard/development/index
+
+Releases, Changes and Roadmap
+:::::::::::::::::::::::::::::
+
+.. toctree::
+    :maxdepth: 2
+
+    changelogs/index
+    roadmap
+    ideas
diff --git a/docs/contribute/introduction.rst b/docs/contribute/introduction.rst
@@ -0,0 +1,6 @@
+Introduction
+============
+
+The Contributor's Guide is there both to help you contribute to harp, but also to help you extend harp with your own
+features. As most of the core features are implemented using applications (harp's extensions), this is a very good
+starting point to write your own, even if you do not plan to publish them.
diff --git a/docs/development/roadmap.rst → docs/contribute/roadmap.rst b/docs/development/roadmap.rst → docs/contribute/roadmap.rst
diff --git a/...elopment/storage/images/storage-model.png → ...ntribute/storage/images/storage-model.png b/...elopment/storage/images/storage-model.png → ...ntribute/storage/images/storage-model.png
diff --git a/docs/development/storage/index.rst → docs/contribute/storage/index.rst b/docs/development/storage/index.rst → docs/contribute/storage/index.rst
diff --git a/docs/develop/customize.rst b/docs/develop/customize.rst
@@ -0,0 +1,11 @@
+Customize
+=========
+
+Most features can be customized using configuration options.
+
+In this section, we'll go through the programmatic configuration options.
+
+.. note::
+
+    You can read about the declarative configuration options in the
+    :doc:`Operator's Guide Configure </operate/configure/index>` section.
diff --git a/docs/develop/extend.rst b/docs/develop/extend.rst
@@ -0,0 +1,8 @@
+Extend
+======
+
+Extending harp is as simple as writing an harp application (which is a standard python package with some additional
+instrumentation) and loading it within your configuration.
+
+To wrtie your own applications, please refer to the
+:doc:`Contributor's Guide Applications section </contribute/applications/index>`.
diff --git a/docs/develop/index.rst b/docs/develop/index.rst
@@ -0,0 +1,9 @@
+Developer's Guide
+=================
+
+.. toctree::
+    :maxdepth: 2
+
+    run
+    customize
+    extend
diff --git a/docs/develop/run.rst b/docs/develop/run.rst
@@ -0,0 +1,8 @@
+Run
+===
+
+.. note::
+
+    This document describes the options to run the application on your local machine. Although the topic is similar, if
+    you're looking for a guide on how to deploy the application to a server, please refer to the
+    :doc:`runtime section of the operator's guide <../operator/runtime>`.
diff --git a/docs/development/dependencies.rst b/docs/development/dependencies.rst
diff --git a/docs/development/index.rst b/docs/development/index.rst
diff --git a/docs/features/agregation-and-splitting.rst b/docs/features/agregation-and-splitting.rst
diff --git a/docs/features/alerting.rst b/docs/features/alerting.rst
diff --git a/docs/features/basics.rst b/docs/features/basics.rst
diff --git a/docs/features/batching.rst b/docs/features/batching.rst
diff --git a/docs/features/caching.rst b/docs/features/caching.rst
diff --git a/docs/features/circuit-breaker.rst b/docs/features/circuit-breaker.rst
diff --git a/docs/features/configuration.rst b/docs/features/configuration.rst
diff --git a/docs/features/dashboard.rst b/docs/features/dashboard.rst
diff --git a/docs/features/debugging.rst b/docs/features/debugging.rst
diff --git a/docs/features/http-proxy.rst b/docs/features/http-proxy.rst
diff --git a/docs/features/images/http-proxy-schema.png b/docs/features/images/http-proxy-schema.png
diff --git a/docs/features/index.rst b/docs/features/index.rst
diff --git a/docs/features/intelligence.rst b/docs/features/intelligence.rst
diff --git a/docs/features/normalization-and-typing.rst b/docs/features/normalization-and-typing.rst
diff --git a/docs/features/prefetching.rst b/docs/features/prefetching.rst
diff --git a/docs/features/retrying.rst b/docs/features/retrying.rst
diff --git a/docs/features/rewriting.rst b/docs/features/rewriting.rst
diff --git a/docs/features/routing.rst b/docs/features/routing.rst