From 3dd1b3f36fe6f8de5984eb343c68e959bebe838c Mon Sep 17 00:00:00 2001 From: Luc Didry Date: Wed, 25 Sep 2024 18:05:09 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=F0=9F=92=84=20=E2=80=94=20Add=20op?= =?UTF-8?q?engraph=20tags=20to=20documentation=20site=20(fix=20#62)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 1 + docs/_static/fix-nav.css | 4 ++++ docs/_static/logo.png | 1 + docs/api.md | 3 +++ docs/changelog.md | 5 ++++- docs/checks.md | 5 ++++- docs/cli.md | 3 +++ docs/conf.py | 13 +++++++++++-- docs/configuration.md | 3 +++ docs/deployment/nginx.md | 3 +++ docs/deployment/systemd.md | 3 +++ docs/developer/dependencies.md | 3 +++ docs/developer/installation.md | 3 +++ docs/developer/license.md | 3 +++ docs/developer/migrations.md | 3 +++ docs/developer/models.md | 16 ++++++++++++++++ docs/developer/new-check.md | 5 ++++- docs/developer/new-notification-way.md | 3 +++ docs/developer/overview.md | 3 +++ docs/developer/release.md | 3 +++ docs/developer/requirements.md | 5 ++++- docs/developer/tests.md | 8 ++++++++ docs/faq.md | 3 +++ docs/index.md | 3 +++ docs/installation/getting-started.md | 3 +++ docs/installation/postgresql.md | 3 +++ docs/installation/tl-dr.md | 3 +++ 27 files changed, 108 insertions(+), 6 deletions(-) create mode 100644 docs/_static/fix-nav.css create mode 120000 docs/_static/logo.png diff --git a/CHANGELOG.md b/CHANGELOG.md index c6fa32b..c285129 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## [Unreleased] - 💄 — Correctly show results on small screens +- 📝💄 — Add opengraph tags to documentation site (#62) ## 0.4.1 diff --git a/docs/_static/fix-nav.css b/docs/_static/fix-nav.css new file mode 100644 index 0000000..d0e5d01 --- /dev/null +++ b/docs/_static/fix-nav.css @@ -0,0 +1,4 @@ +.sy-head-brand img + strong { + display: inline; + margin-left: 1em; +} diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 120000 index 0000000..ff65d50 --- /dev/null +++ b/docs/_static/logo.png @@ -0,0 +1 @@ +../../argos/server/static/logo.png \ No newline at end of file diff --git a/docs/api.md b/docs/api.md index 7fe1b2a..4272995 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,3 +1,6 @@ +--- +description: Argos exposes a website and an API. This is how to use the API. +--- # The HTTP API Argos exposes a website and an API. The website is available at "/" and the API at "/api". diff --git a/docs/changelog.md b/docs/changelog.md index 8261b35..029cce1 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,2 +1,5 @@ +--- +description: Last changes in Argos. +--- ```{include} ../CHANGELOG.md -``` \ No newline at end of file +``` diff --git a/docs/checks.md b/docs/checks.md index 06fddd6..dcbe764 100644 --- a/docs/checks.md +++ b/docs/checks.md @@ -1,6 +1,9 @@ +--- +description: Here are the checks that Argos proposes, with a description of what they do and how to configure them. +--- # Checks -At its core, argos runs checks and return the results to the service. Here are the implemented checks, with a description of what they do and how to configure them. +At its core, Argos runs checks and return the results to the service. Here are the implemented checks, with a description of what they do and how to configure them. ## Simple checks diff --git a/docs/cli.md b/docs/cli.md index cd17663..9d018af 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -1,3 +1,6 @@ +--- +description: How to use Argos from the command line. +--- # Command-line interface