Merge pull request #37 from querqy/update_documentation

Update documentation to reflect where we are in 2024.

docs/requirements.txt

@@ -1,2 +1,2 @@
-sphinx==4.3.0
-sphinx_rtd_theme==1.0.0
+sphinx==7.2.6
+sphinx_rtd_theme==2.0.0

docs/source/conf.py

@@ -49,7 +49,7 @@
 
 # General information about the project.
 project = 'querqy.org'
-copyright = '2020-22, querqy.org documentation authors'
+copyright = '2020-24, querqy.org documentation authors'
 author = 'René Kriegler'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -66,7 +66,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/source/smui/config.rst

@@ -56,7 +56,7 @@ using environment variables:
      - ``/tmp/search-management-ui_rules-txt.tmp`` (recommended: leave default).
    * - ``smui2solr.DST_CP_FILE_TO``
      - ``SMUI_2SOLR_DST_CP_FILE_TO``
-     - LIVE ``rules.txt`` destination file for the default deployment script. See :ref:`Details on rules.txt deployment<smui-rules-deployment-details>` for more info. WARNING: Deprecated as of v3.4, will be replaced soon.
+     - LIVE ``rules.txt`` destination file for the default deployment script. See :ref:`Details on rules.txt deployment<options-for-rules-deployment>` for more info. WARNING: Deprecated as of v3.4, will be replaced soon.
      - ``/usr/bin/solr/defaultCore/conf/rules.txt``
    * - ``smui.deployment.git.repo-url``
      - ``SMUI_DEPLOYMENT_GIT_REPO_URL``
@@ -186,7 +186,7 @@ The following settings are optional and define the general SMUI behaviour:
      - ``/usr/bin/solr/defaultCore/conf/rules.txt``
      - ``/usr/bin/solr/liveCore/conf/replace-rules.txt``
    * - ``smui2solr.deploy-prelive-fn-replace-txt``
-     - PRELIVE ``replace_rules.txt`` destination file for the default deployment script. See :ref:`Details on rules.txt deployment<smui-rules-deployment-details>` for more info.
+     - PRELIVE ``replace_rules.txt`` destination file for the default deployment script. See :ref:`Details on rules.txt deployment<options-for-rules-deployment>` for more info.
      -  ``/usr/bin/solr/preliveCore/conf/replace-rules.txt``
    * - ``toggle.display-username.default``
      - **WARNING:** Deprecated as of v3.14, will be replaced soon (see `github.com comment on PR#83 <https://github.com/querqy/smui/pull/83#issuecomment-1023284550>`_). Default username for being displayed on the frontend, if no username is available (e.g. for event history).
@@ -401,11 +401,12 @@ After the above steps you are able to run SMUI with enabled SAML authentication
 Session and Logout
 ~~~~~~~~~~~~~~~~~~~~
 
-An authenticated user will stay logged in as long as their cookie is valid (see ``SMUI_SESSION_MAXAGE` value above).
+An authenticated user will stay logged in as long as their cookie is valid (see ``SMUI_SESSION_MAXAGE`` value above).
 As we currently only support external authentication there is currently no active logout implemented (any logout
 would immediately redirect to the identity provider and, if the session with the identity provider still exists,
 re-login the user).
 
+.. _options-for-rules-deployment:
 
 Options for rules deployment
 ----------------------------

docs/source/smui/contributors.rst

@@ -12,3 +12,13 @@ Thanks to all the great developers that contributed to SMUI:
 -  `Matthias Krüger <https://github.com/mkr>`__
 -  `Gunnar Busch <https://github.com/gunnarbusch>`__
 -  `Moritz Wagner <https://github.com/recombinationgroup>`__
+-  `Dominic Bestler <https://github.com/dobestler>`__
+-  `Martin Knoller Stocker <https://github.com/linuxswords>`__
+-  `Marco Priebe <https://github.com/MarcoPriebe>`__
+-  `Jan Hacker <https://github.com/schnoddelbotz>`__
+-  `René Kriegler <https://github.com/renekrie>`__
+-  `Paul Blanchaert <https://github.com/Paul-Blanchaert>`__
+-  `Juan Cruz Lapadula Plá <https://github.com/jclapadula>`__
+-  `Gunnar Busch <https://github.com/gunnarbusch>`__
+-  `Eric Pugh <https://github.com/epugh>`__
+-  `Alexandre Rafalovitch <https://github.com/arafalov>`__

docs/source/smui/dev-setup.rst

@@ -91,7 +91,8 @@ Here are some frequently used command:
 * ``test``: Runs all backend tests.
 
 ::
-    sbt "run -Dconfig.file=./smui-dev.conf"
+
+   sbt "run -Dconfig.file=./smui-dev.conf"
 
 .. _smui-dev-config:
 
@@ -102,7 +103,8 @@ For local development that requires accessing SMUI using a HTTPS URL (e.g. to im
 we recommend using the Caddy reverse proxy.
 
 ::
-    caddy reverse-proxy --internal-certs --from https://localhost --to :9000
+
+   caddy reverse-proxy --internal-certs --from https://localhost --to :9000   
 
 Development configuration
 -------------------------
@@ -156,7 +158,7 @@ e.g.:
 
 ::
 
-   run -Dconfig.file=./smui-dev.conf 9000
+   sbt run -Dconfig.file=./smui-dev.conf 9000
 
 Furthermore, above’s configuration points to an alternative development
 version of the ``smui2solr.sh``-script. The file ``smui2solr-dev.sh`` is
@@ -288,7 +290,8 @@ Releasing SMUI
 Every release of SMUI should come with its own version incrementing at least the build number of the semver. The release number is maintained under:
 
 ::
-    smui/build.sbt
+
+   smui/build.sbt
 
 The ``SmuiVersionSpec`` enforces version number increments in the test automation.
 

docs/source/smui/index.rst

@@ -31,7 +31,7 @@ The basic workflow of SMUI is as follows:
 - Create Rules for various Search Inputs
 - Deploy the Rules in a Deployment Channel
 
-The deployment may occur by :ref:`various methods<smui-rules-deployment-details>`. After deployment, the set
+The deployment may occur by :ref:`various methods<options-for-rules-deployment>`. After deployment, the set
 of Rules in the Deployment Channel will be recognized by the Querqy plugin and thus applied to queries.
 
 Rule types

docs/source/smui/quickstart.rst

@@ -16,7 +16,7 @@ To quickly get SMUI up and running on your machine, you may use the bundled `doc
 
     git clone https://github.com/querqy/smui.git smui
     cd smui
-    docker-compose up
+    docker compose up
 
 Alternatively, you may start the containers manually like this: