Added character escapes, formatted links, and upgraded to node 18 and…

… docusaurus 3.3.2
rucio · Jun 5, 2024 · fd35614 · fd35614
1 parent a02f565
commit fd35614
Show file tree

Hide file tree

Showing 12 changed files with 135 additions and 133 deletions.
diff --git a/.github/workflows/update_documentation.yml b/.github/workflows/update_documentation.yml
@@ -74,9 +74,9 @@ jobs:
           repository: rucio/rucio
           ref: master
           path: tools/run_in_docker/rucio
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 18
       - name: Install rucio-api generation dependencies and build markdown sites for the API
         run: |
           python3 -m pip install -U pip setuptools

diff --git a/docs/about_our_contributors.md b/docs/about_our_contributors.md
@@ -14,63 +14,62 @@ repository](https://github.com/rucio/documentation) before making a submission.
 # Individual contributors to the source code
 
 ---
-
-- Mario Lassnig <mario.lassnig@cern.ch>, 2012-2021
-- Vincent Garonne <vgaronne@gmail.com>, 2012-2019
-- Angelos Molfetas <Angelos.Molfetas@cern.ch>, 2012
-- Martin Barisits <martin.barisits@cern.ch>, 2012-2021
-- Thomas Beermann <thomas.beermann@cern.ch>, 2012-2021
-- Ralph Vigne <ralph.vigne@cern.ch>, 2012-2016
-- Graeme Stewart <graeme.andrew.stewart@cern.ch>, 2012
-- Yun-Pin Sun <winter0128@gmail.com>, 2012-2013
-- Cedric Serfon <cedric.serfon@cern.ch>, 2012-2021
-- Luis Rodrigues <lfrodrigues@gmail.com>, 2013
-- WeiJen Chang <e4523744@gmail.com>, 2013-2014
-- Gancho Dimitrov <gancho.dimitrov@cern.ch>, 2013
-- Wen Guan <wguan.icedew@gmail.com>, 2014-2017
-- David Cameron <d.g.cameron@gmail.com>, 2014-2016
-- Tomáš Kouba <tomas.kouba@cern.ch>, 2014-2015
-- Cheng-Hsi Chao <cheng-hsi.chao@cern.ch>, 2014
-- Evangelia Liotiri <evangelia.liotiri@cern.ch>, 2014-2015
-- Joaquín Bogado <jbogado@linti.unlp.edu.ar>, 2014-2018
-- Fernando López <fernando.e.lopez@gmail.com>, 2015-2016
-- Sylvain Blunier <sylvain.blunier@cern.ch>, 2016
-- Tomas Javurek <tomas.javurek@cern.ch>, 2016-2020
-- Brian Bockelman <bbockelm@cse.unl.edu>, 2016-2018
-- Tobias Wegner <twegner@cern.ch>, 2017-2020
-- Frank Berghaus <frank.berghaus@cern.ch>, 2017
-- Vitjan Zavrtanik <vitjan.zavrtanik@cern.ch>, 2017
-- Stefan Prenner <stefan.prenner@cern.ch>, 2017-2018
-- Nicolo Magini <Nicolo.Magini@cern.ch>, 2017-2018
-- Oliver Freyermuth <o.freyermuth@googlemail.com>, 2017
-- Eric Vaandering <ericvaandering@gmail.com>, 2018
-- Dimitrios Christidis <dimitrios.christidis@cern.ch>, 2018-2021
-- Igor Mandrichenko <ivm@fnal.gov>, 2018
-- Shreyansh Khajanchi <shreyansh_k@live.com>, 2018
-- Robert Illingworth <illingwo@fnal.gov>, 2018
-- Hannes Hansen <hannes.jakob.hansen@cern.ch>, 2018-2019
-- James Perry <j.perry@epcc.ed.ac.uk>, 2019-2021
-- Vivek Nigam <viveknigam.nigam3@gmail.com>, 2019 - 2020
-- Kaustubh Hiware <hiwarekaustubh@gmail.com>, 2019
-- Florido Paganelli <florido.paganelli@hep.lu.se>, 2019
-- Boris Bauermeister <Boris.Bauermeister@gmail.com> 2019
-- Ruturaj Gujar <ruturaj.gujar23@gmail.com> 2019
-- Andrew Lister <andrew.lister@stfc.ac.uk>, 2019
-- Aristeidis Fkiaras <aristeidis.fkiaras@cern.ch>, 2019
-- Benedikt Ziemons <benedikt.ziemons@cern.ch>, 2020-2021
-- Muhammad Aditya Hilmy <mhilmy@hey.com>, 2020
-- Eli Chadwick <eli.chadwick@stfc.ac.uk>, 2020
-- Patrick Austin <patrick.austin@stfc.ac.uk>, 2020
-- Rob Barnsley <R.Barnsley@skatelescope.org>, 2020
-- Alan Malta Rodrigues <alan.malta@cern.ch>, 2020
-- Rizart Dona <rizart.dona@gmail.com>, 2021-2022
-- Aksel Lunde Aase <aksel.lunde.aase@gmail.com>, 2022
-- Anton Schwarz <anton.schwarz@cern.ch>, 2022
-- Johannes Lange <johannes.lange@uni-hamburg.de>, 2022-2023
-- Domenic Gosein <domenic.gosein@cern.ch>, 2023
-- Eraldo Junior <esilvaju@cern.ch>, 2021-2024
-- Dimitris Xenakis <d.xenakis@ieee.org>, 2024
-- Fabio Luchetti <fabio.luchetti@cern.ch>, 2021
+- Mario Lassnig [mario.lassnig@cern.ch](mailto:mario.lassnig@cern.ch), 2012-2021
+- Vincent Garonne [vgaronne@gmail.com](mailto:vgaronne@gmail.com), 2012-2019
+- Angelos Molfetas [Angelos.Molfetas@cern.c](mailto:Angelos.Molfetas@cern.ch), 2012
+- Martin Barisits [martin.barisits@cern.ch](mailto:martin.barisits@cern.ch), 2012-2021
+- Thomas Beermann [thomas.beermann@cern.ch](mailto:thomas.beermann@cern.ch), 2012-2021
+- Ralph Vigne [ralph.vigne@cern.ch](mailto:ralph.vigne@cern.ch), 2012-2016
+- Graeme Stewart [graeme.andrew.stewart@cern.ch](mailto:graeme.andrew.stewart@cern.ch), 2012
+- Yun-Pin Sun [winter0128@gmail.com](mailto:winter0128@gmail.com), 2012-2013
+- Cedric Serfon [cedric.serfon@cern.ch](mailto:cedric.serfon@cern.ch), 2012-2021
+- Luis Rodrigues [lfrodrigues@gmail.com](mailto:lfrodrigues@gmail.com), 2013
+- WeiJen Chang [e4523744@gmail.com](mailto:e4523744@gmail.com), 2013-2014
+- Gancho Dimitrov [gancho.dimitrov@cern.ch](mailto:gancho.dimitrov@cern.ch), 2013
+- Wen Guan [wguan.icedew@gmail.co](mailto:wguan.icedew@gmail.com), 2014-2017
+- David Cameron [d.g.cameron@gmail.com](mailto:d.g.cameron@gmail.com), 2014-2016
+- Tomáš Kouba [tomas.kouba@cern.ch](mailto:tomas.kouba@cern.ch), 2014-2015
+- Cheng-Hsi Chao [cheng-hsi.chao@cern.ch](mailto:cheng-hsi.chao@cern.ch), 2014
+- Evangelia Liotiri [evangelia.liotiri@cern.ch](mailto:evangelia.liotiri@cern.ch), 2014-2015
+- Joaquín Bogado [jbogado@linti.unlp.edu.ar](mailto:jbogado@linti.unlp.edu.ar), 2014-2018
+- Fernando López [fernando.e.lopez@gmail.com](mailto:fernando.e.lopez@gmail.com), 2015-2016
+- Sylvain Blunier [sylvain.blunier@cern.ch](mailto:sylvain.blunier@cern.ch), 2016
+- Tomas Javurek [tomas.javurek@cern.ch](mailto:tomas.javurek@cern.ch), 2016-2020
+- Brian Bockelman [bbockelm@cse.unl.edu](mailto:bbockelm@cse.unl.edu), 2016-2018
+- Tobias Wegner [twegner@cern.ch](mailto:twegner@cern.ch), 2017-2020
+- Frank Berghaus [frank.berghaus@cern.ch)](mailto:frank.berghaus@cern.ch), 2017
+- Vitjan Zavrtanik [vitjan.zavrtanik@cern.ch](mailto:vitjan.zavrtanik@cern.ch), 2017
+- Stefan Prenner [stefan.prenner@cern.ch](mailto:stefan.prenner@cern.ch), 2017-2018
+- Nicolo Magini [Nicolo.Magini@cern.ch](mailto:Nicolo.Magini@cern.ch), 2017-2018
+- Oliver Freyermuth [o.freyermuth@googlemail.co](mailto:o.freyermuth@googlemail.com), 2017
+- Eric Vaandering [ericvaandering@gmail.co](mailto:ericvaandering@gmail.com), 2018
+- Dimitrios Christidis [dimitrios.christidis@cern.ch](mailto:dimitrios.christidis@cern.ch), 2018-2021
+- Igor Mandrichenko [ivm@fnal.gov](mailto:ivm@fnal.gov), 2018
+- Shreyansh Khajanchi [shreyansh_k@live.com](mailto:shreyansh_k@live.com), 2018
+- Robert Illingworth [illingwo@fnal.gov](mailto:illingwo@fnal.gov), 2018
+- Hannes Hansen [hannes.jakob.hansen@cern.c](mailto:hannes.jakob.hansen@cern.ch), 2018-2019
+- James Perry [j.perry@epcc.ed.ac.uk](mailto:j.perry@epcc.ed.ac.uk), 2019-2021
+- Vivek Nigam [viveknigam.nigam3@gmail.com](mailto:viveknigam.nigam3@gmail.com), 2019 - 2020
+- Kaustubh Hiware [hiwarekaustubh@gmail.co](mailto:hiwarekaustubh@gmail.com), 2019
+- Florido Paganelli [florido.paganelli@hep.lu.se](mailto:florido.paganelli@hep.lu.se), 2019
+- Boris Bauermeister [Boris.Bauermeister@gmail.com](mailto:Boris.Bauermeister@gmail.com) 2019
+- Ruturaj Gujar [ruturaj.gujar23@gmail.com](mailto:ruturaj.gujar23@gmail.com) 2019
+- Andrew Lister [andrew.lister@stfc.ac.uk](mailto:andrew.lister@stfc.ac.uk), 2019
+- Aristeidis Fkiaras [aristeidis.fkiaras@cern.ch](mailto:aristeidis.fkiaras@cern.ch), 2019
+- Benedikt Ziemons [benedikt.ziemons@cern.ch](mailto:benedikt.ziemons@cern.ch), 2020-2021
+- Muhammad Aditya Hilmy [mhilmy@hey.com](mailto:mhilmy@hey.com), 2020
+- Eli Chadwick [eli.chadwick@stfc.ac.uk](mailto:eli.chadwick@stfc.ac.uk), 2020
+- Patrick Austin [:patrick.austin@stfc.ac.uk](mailto:patrick.austin@stfc.ac.uk), 2020
+- Rob Barnsley [R.Barnsley@skatelescope.org](mailto:R.Barnsley@skatelescope.org), 2020
+- Alan Malta Rodrigues [alan.malta@cern.ch](mailto:alan.malta@cern.ch), 2020
+- Rizart Dona [rizart.dona@gmail.com](mailto:rizart.dona@gmail.com), 2021-2022
+- Aksel Lunde Aase [aksel.lunde.aase@gmail.co](mailto:aksel.lunde.aase@gmail.com), 2022
+- Anton Schwarz [anton.schwarz@cern.ch](mailto:anton.schwarz@cern.ch), 2022
+- Johannes Lange [johannes.lange@uni-hamburg.de](mailto:johannes.lange@uni-hamburg.de), 2022-2023
+- Domenic Gosein [domenic.gosein@cern.ch](mailto:domenic.gosein@cern.ch), 2023
+- Eraldo Junior [esilvaju@cern.ch](mailto:esilvaju@cern.ch), 2021-2024
+- Dimitris Xenakis [d.xenakis@ieee.org](mailto:d.xenakis@ieee.org), 2024
+- Fabio Luchetti [fabio.luchetti@cern.ch](mailto:fabio.luchetti@cern.chg), 2021
 
 # Organisations employing contributors
 

diff --git a/docs/contact_us.md b/docs/contact_us.md
@@ -23,7 +23,7 @@ and you can view the schedule [here](https://indico.cern.ch/category/10588/).
 
 ## Rucio news mailing list
 
-We have a dedicated news mailing list for general announcements (<10 eMails per
+We have a dedicated news mailing list for general announcements (\<10 eMails per
 year) for the Rucio community. You can subscribe to [rucio-news@cern.ch](https://e-groups.cern.ch/e-groups/Egroup.do?egroupId=10586148)
 directly with a CERN account, for external subscribers please send an eMail
 to [rucio-news-subscribe@cern.ch](mailto:rucio-news-subscribe@cern.ch?subject=Subscribe).

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -48,8 +48,7 @@ The following figure might help you with an overview:
 
 ### 1. Prerequisite
 
-* Ensure you add your name (and organisation) to our [__list of
-  contributors__](about_our_contributors.md).
+* Ensure you add your name (and organisation) to our list of [__contributors__](about_our_contributors.md).
 
 * Fork the [__repository__](https://github.com/rucio/rucio/) on
   Github.
@@ -88,8 +87,7 @@ The following figure might help you with an overview:
   pre-commit install --hook-type pre-push
   ```
 
-  More information:
-  <https://pre-commit.com/#confining-hooks-to-run-at-certain-stages>
+  More information [please view the pre-commit documentation](https://pre-commit.com/#confining-hooks-to-run-at-certain-stages)
 
 ### 2. Create an Issue
 
@@ -130,8 +128,7 @@ list__](https://github.com/rucio/rucio/labels) and are usually specified on the
 issue of the change.
 
 Add additional explanations to the body of the commit, such as motivation for
-certain decisions and background information. Here are some general rules:
-<https://cbea.ms/git-commit/>.
+certain decisions and background information. [Here are some general rules.](https://cbea.ms/git-commit/).
 
 If you add a [__github-recognised
 keyword__](https://help.github.com/articles/closing-issues-using-keywords/) then

diff --git a/docs/developer/setting_up_mac_apple_silicon.md b/docs/developer/setting_up_mac_apple_silicon.md
@@ -23,8 +23,11 @@ In order to force Docker to run commands with platform `linux/amd64` instead of
 
 Set Docker default platform to `linux/amd64`:
 
+```bash
     export DOCKER_DEFAULT_PLATFORM=linux/amd64
+```
 
 Or run it as part of the command a single time:
-
+```bash
     DOCKER_DEFAULT_PLATFORM=linux/amd64 docker-compose -f <docker-compose-file.yml>
+```
diff --git a/docs/operator/configuration_parameters.md b/docs/operator/configuration_parameters.md
@@ -121,13 +121,11 @@ Rucio will look for the config in the following locations -
 #### **common**
   - **extract_scope**: _(Optional)_ <!--??--> Default: `atlas`.
   - **logdir**: Path of the directory for logs. Contains `auditor.log`.
-  - **logformat**: _(Optional)_ Formatter of the log. See:
-    <https://docs.python.org/3/library/logging.html#logging.Formatter>
+  - **logformat**: _(Optional)_ Formatter of the log. See [the logging formatter documentation](https://docs.python.org/3/library/logging.html#logging.Formatter)
   - **loglevel**: _(Optional)_. Set the root logger level to the specified
     level.
 
-    Values: `{'NOTSET', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'}`. See:
-    <https://docs.python.org/3/library/logging.html#levels>
+    Values: `{'NOTSET', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'}`. See [documentation for logging levels](https://docs.python.org/3/library/logging.html#levels)
 
     Default: `DEBUG`. For `rucio-auditor` default is `WARNING`.
   - **mailtemplatedir**: _(Optional)_ Path of the folder with mail templates
@@ -168,7 +166,7 @@ Rucio will look for the config in the following locations -
 #### **core**
   - **default_mail_from**: _(Optional)_ Default email. Default: `None`.
   - **geoip_licence_key**: _(Optional)_ License key for GeoLite2. Get a free
-    licence key at <https://www.maxmind.com/en/geolite2/signup>. Default:
+    licence key at [the signup page](https://www.maxmind.com/en/geolite2/signup). Default:
     `NOLICENCE`.
   - **use_temp_tables**: _(Optional)_ Use Rucio with temporary table workflows.
     Default: `False`.
@@ -227,22 +225,16 @@ Rucio will look for the config in the following locations -
     sqlite, oracle}`.
   - **echo**: Enable echo for database logs. Values: `{0 (disable), 1
     (enable)}`.
-  - **echo_pool**: See
-    <https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.echo_pool>
-  - **max_overflow**: See
-    <https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.max_overflow>
-  - **pool_recycle**: See
-    <https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.pool_recycle>
-  - **pool_reset_on_return**: See
-    <https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.pool_reset_on_return>
-  - **pool_size**: See
-    <https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.pool_size>
-  - **pool_timeout**:
-    <https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.pool_timeout>
+  - **echo_pool**: See [sqlalchemy documentation](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.echo_pool)
+  - **max_overflow**: See [sqlalchemy documentation](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.max_overflow)
+  - **pool_recycle**: See [sqlalchemy documentation](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.pool_recycle)
+  - **pool_reset_on_return**: See [sqlalchemy documentation](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.pool_reset_on_return)
+  - **pool_size**: See [sqlalchemy documentation](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.pool_size)
+  - **pool_timeout**: [sqlalchemy documentation](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.pool_timeout)
   - **poolclass**: Which connection pooling mechanism to use. Values: `nullpool`
     (disables pooling), `queuepool` (default for all but SQLite engine), or
     `singletonthreadpool` (default for SQLite engine).
-    See <https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.poolclass>
+    See [sqlalchemy documentation](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.poolclass)
   - **schema**: _(Optional)_ Schema to be applied to a database, if not set in
     config, try to create automatically.
   - **use_threadlocal** <!--??-->
@@ -355,12 +347,10 @@ Rucio will look for the config in the following locations -
 #### **nongrid-trace**
   - **broker_virtual_host**: _(Optional)_ ?. No default.
   - **brokers**: Brokers separated by commas. Example: `atlas-test-mb.cern.ch`.
-  - **logformat**: _(Optional)_ Formatter of the log. See:
-    <https://docs.python.org/3/library/logging.html#logging.Formatter>
+  - **logformat**: _(Optional)_ Formatter of the log. See [logging documentation](https://docs.python.org/3/library/logging.html#logging.Formatter).
   - **loglevel**: _(Optional)_ Set the root logger level to the specified level.
 
-    Values: `{'NOTSET', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'}`. See:
-    <https://docs.python.org/3/library/logging.html#levels>
+    Values: `{'NOTSET', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'}`. See [logging documentation](https://docs.python.org/3/library/logging.html#levels).
 
     Default: `DEBUG`.
   - **password**: Password of the `username`.
@@ -403,12 +393,9 @@ Rucio will look for the config in the following locations -
 #### **trace**
   - **broker_virtual_host**: _(Optional)_ <!--??--> No default.
   - **brokers**: Brokers separated by commas. Example: `atlas-test-mb.cern.ch`.
-  - **logformat**: _(Optional)_ Formatter of the log. See:
-    <https://docs.python.org/3/library/logging.html#logging.Formatter>
-  - **loglevel**: _(Optional)_ Set the root logger level to the specified level
-
-    Values: `{'NOTSET', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'}`. See:
-    <https://docs.python.org/3/library/logging.html#levels>
+  - **logformat**: _(Optional)_ Formatter of the log. See [logging documentation](https://docs.python.org/3/library/logging.html#logging.Formatter).
+  - **loglevel**: _(Optional)_ Set the root logger level to the specified level.
+    Values: `{'NOTSET', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'}`. See [logging documentation](https://docs.python.org/3/library/logging.html#levels).
 
     Default: `DEBUG`.
   - **password**: Password of the `username`.
@@ -427,8 +414,7 @@ Rucio will look for the config in the following locations -
   - **password**: _(Optional)_ Password of the `username`. Mandatory if
     `use_ssl` is not set. No default.
   - **port**: Port of the broker.
-  - **prefetch_size**: `activemq.prefetchSize`, see
-    <https://activemq.apache.org/what-is-the-prefetch-limit-for>
+  - **prefetch_size**: `activemq.prefetchSize`, see [activemq documentation](https://activemq.apache.org/what-is-the-prefetch-limit-for)
   - **queue**: The topic or queue to subscribe to. Example:
     `/queue/Consumer.kronos.rucio.tracer`.
   - **reconnect_attempts**: Maximum attempts to reconnect. Integer. Example: