From e1a636c6844a7270376e1fad0d3b262a9a9a6ca7 Mon Sep 17 00:00:00 2001 From: ix5 Date: Fri, 3 May 2024 13:32:33 +0200 Subject: [PATCH 1/5] docs,contrib: Suggest dbpath under /db/ more strongly Otherwise users would have the docker daemon destroy their databases on every container restart --- contrib/isso-dev.cfg | 1 + contrib/isso.sample.cfg | 1 + docs/docs/guides/quickstart.rst | 2 ++ docs/docs/reference/installation.rst | 3 +++ 4 files changed, 7 insertions(+) diff --git a/contrib/isso-dev.cfg b/contrib/isso-dev.cfg index d3820ee5..760494b4 100644 --- a/contrib/isso-dev.cfg +++ b/contrib/isso-dev.cfg @@ -5,6 +5,7 @@ [general] +# Change dbpath to /db/comments.db if running in docker! dbpath = comments.db host = http://isso-dev.local/ diff --git a/contrib/isso.sample.cfg b/contrib/isso.sample.cfg index f3bb41a5..60bdaf11 100644 --- a/contrib/isso.sample.cfg +++ b/contrib/isso.sample.cfg @@ -3,6 +3,7 @@ [general] +# Change dbpath to /db/comments.db if running in docker! dbpath = comments.db host = http://localhost:80/ diff --git a/docs/docs/guides/quickstart.rst b/docs/docs/guides/quickstart.rst index cb072d59..617ca99f 100644 --- a/docs/docs/guides/quickstart.rst +++ b/docs/docs/guides/quickstart.rst @@ -22,6 +22,8 @@ sane defaults. ; database location, check permissions, automatically created if it ; does not exist dbpath = /var/lib/isso/comments.db + ; for docker image: dbpath = /db/comments.db + ; ; your website or blog (not the location of Isso!) host = http://example.tld/ ; you can add multiple hosts for local development diff --git a/docs/docs/reference/installation.rst b/docs/docs/reference/installation.rst index 16e03afc..cab921ae 100644 --- a/docs/docs/reference/installation.rst +++ b/docs/docs/reference/installation.rst @@ -167,6 +167,9 @@ The maintainers recommend pinning the image to a `release tag`_, e.g. .. code-block:: console $ docker pull ghcr.io/isso-comments/isso:release + $ mkdir -p config/ db/ + $ cp contrib/isso.sample.cfg config/isso.cfg + # Set 'dbpath' to '/db/comments.db' and adjust 'host' $ docker run -d --rm --name isso -p 127.0.0.1:8080:8080 \ -v /var/lib/isso:/config -v /var/lib/isso:/db \ ghcr.io/isso-comments/isso:release From db6e7f0e73514719f42e8924ecf9ad14db41b193 Mon Sep 17 00:00:00 2001 From: ix5 Date: Mon, 29 Apr 2024 23:32:40 +0200 Subject: [PATCH 2/5] docs/installation: Expand AUR, mention removal from Debian --- docs/docs/reference/installation.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/docs/reference/installation.rst b/docs/docs/reference/installation.rst index cab921ae..8853fda6 100644 --- a/docs/docs/reference/installation.rst +++ b/docs/docs/reference/installation.rst @@ -133,9 +133,16 @@ To upgrade Isso, activate your virtual environment again, and run Prebuilt Packages ----------------- -* Debian (since Buster): https://packages.debian.org/search?keywords=isso - -* Arch Linux: https://aur.archlinux.org/packages/isso/ +* Arch Linux: The `isso`_ AUR package (maintained by `@HLFH`_) follows the + latest stable release, while the `isso-git`_ package (maintained by + `@AlphaJack`_) always builds the latest commit from ``git``. +* Debian: The package was `dropped in 2021`_ from the Debian repositories. + +.. _isso: https://aur.archlinux.org/packages/isso +.. _@HLFH: https://github.com/HLFH +.. _isso-git: https://aur.archlinux.org/packages/isso-git +.. _@AlphaJack: https://github.com/AlphaJack +.. _dropped in 2021: https://tracker.debian.org/pkg/isso .. _using-docker: From 32848dc1e3bc03b9210391fb84a226ab8ec2327e Mon Sep 17 00:00:00 2001 From: ix5 Date: Sun, 5 May 2024 18:27:51 +0200 Subject: [PATCH 3/5] docs: Remove remaining mentions of Matrix-IRC bridge This is a fixup of https://github.com/isso-comments/isso/pull/1011 which did not entirely remove all mentions Also make the low participation in the IRC channel clearer --- docs/community.rst | 7 +++---- docs/index.html | 3 +-- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/community.rst b/docs/community.rst index 6f48e7db..e894d15d 100644 --- a/docs/community.rst +++ b/docs/community.rst @@ -11,10 +11,9 @@ Getting in contact The main place of interaction for the Isso community is the `GitHub issue tracker `_. -A few people - including the lead developers and maintainers - frequent the -``#isso`` channel, which you can join via -`Matrix `_ or via IRC on -`Libera.Chat `_ +A few people - including some of the lead developers and maintainers - +sometimes participate in the ``#isso`` channel, which you can join via IRC on +`Libera.Chat `_. You may also ask questions or suggest improvements on `GitHub Discussions `_. diff --git a/docs/index.html b/docs/index.html index 068269cd..b82d2220 100644 --- a/docs/index.html +++ b/docs/index.html @@ -46,8 +46,7 @@

Links

Help

- Join #isso via Matrix - or via IRC on Libera.Chat, + Join #isso via IRC on Libera.Chat, or ask a question on GitHub Discussions.

Contribute

From 61810fc190938c36b7479ac164b2085afeb212ef Mon Sep 17 00:00:00 2001 From: ix5 Date: Sun, 5 May 2024 17:40:20 +0200 Subject: [PATCH 4/5] [nit] docs: infra: Reflect auto-build of testbed img --- docs/docs/contributing/infrastructure.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/docs/contributing/infrastructure.rst b/docs/docs/contributing/infrastructure.rst index b82d6880..5710461f 100644 --- a/docs/docs/contributing/infrastructure.rst +++ b/docs/docs/contributing/infrastructure.rst @@ -74,7 +74,7 @@ maintainer review before merging. Packaging --------- -Isso is released "officially" to as an installable Python package on `PyPI`_ +Isso is released "officially" as an installable Python package on `PyPI`_ and as a docker image. Other distributors may package releases of Isso natively for operating systems (e.g. for the Arch User repository or formerly Debian), but support for these releases should be given by the packager. @@ -96,8 +96,9 @@ The `ghcr.io/isso-comments/isso docker image`_ is rebuilt on every push to inherited from the main ``isso-comments/isso`` GitHub repository (toggle ``Inherit access from source repository`` turned on). -The `ghcr.io/isso-comments/isso-js-testbed`_ image for running ``Jest``-based -unit and integration tests is built and pushed manually by @ix5 so far. +The `ghcr.io/isso-comments/isso-js-testbed`_ image for running ``Jest``- and +``puppet``-based unit and integration tests is rebuilt and pushed every week by +a GitHub Action. .. _ghcr.io/isso-comments/isso docker image: https://github.com/isso-comments/isso/pkgs/container/isso .. _ghcr.io/isso-comments/isso-js-testbed: https://github.com/orgs/isso-comments/packages/container/package/isso-js-testbed From c155e1c9264a3c560f6dd0abbf741065120e9f48 Mon Sep 17 00:00:00 2001 From: ix5 Date: Fri, 15 Mar 2024 22:27:11 +0100 Subject: [PATCH 5/5] docs: client-config: Correct default val for reveal-on-click --- docs/docs/reference/client-config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/reference/client-config.rst b/docs/docs/reference/client-config.rst index 891e2abc..40a1e267 100644 --- a/docs/docs/reference/client-config.rst +++ b/docs/docs/reference/client-config.rst @@ -143,7 +143,7 @@ data-isso-max-comments-nested data-isso-reveal-on-click Number of comments to reveal on clicking the "X Hidden" link. - Default: ``true`` + Default: ``5`` .. _data-isso-avatar: