From 5a45ad330187160d0729b0481640afe67c61de16 Mon Sep 17 00:00:00 2001 From: Michael Hanke Date: Wed, 15 Nov 2023 13:55:58 +0100 Subject: [PATCH 1/2] Revert "fixes and tweaks to glossary that increase readibility when links aren't rendered" This reverts commit 4ade62fcdaaf588e556f4cc033814ba10b5cb815. --- docs/glossary.rst | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/glossary.rst b/docs/glossary.rst index 67cc26620..4d2c03c22 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -83,8 +83,7 @@ Glossary or checkout. This has advantages: The repository is leaner, it is easier for administrators to perform garbage collections, and it is required if you want to push to it at all times. You can find out more on what bare repositories are and how to use them - in the Git documentation at `git-scm.com/book/Git-on-the-Server-Getting-Git-on-a - -Server `__. bash @@ -225,7 +224,7 @@ Glossary Docker `Docker `_ is a containerization software that can package software into :term:`software container`\s, similar to :term:`Singularity`. - Find out more on `wikipedia.org/wiki/Docker_(software) `__. + Find out more on `Wikipedia `__. Docker-Hub .. index:: @@ -250,7 +249,7 @@ Glossary .. index:: ! operating system concept; environment variable A variable made up of a name/value pair. Programs using a given environment variable will use its associated value for their execution. - You can find out a bit more :ref:`in the Find-out-more on environment variables `. + You can find out a bit more on environment variable :ref:`in this Findoutmore `. ephemeral clone .. index:: clone (ephemeral); DataLad concept @@ -282,8 +281,8 @@ Glossary Git A version control system to track changes made to small-sized files over time. You can find out - more about Git in `the (free) GitPro book git-scm.com/book `_ - or `interactive Git tutorials try.github.io `_ on :term:`GitHub`. + more about git in `the (free) GitPro book `_ + or `interactive Git tutorials `_ on :term:`GitHub`. git-annex A distributed file synchronization system, enabling sharing and synchronizing collections @@ -343,7 +342,7 @@ Glossary high-throughput computing HTC - A computing environment build from a bond of computers and tuned to deliver large amounts of computational power to allow parallel processing of independent computational jobs. For more information, see `the Wikipedia entry at wikipedia.org/wiki/High-throughput_computing `_. + A computing environment build from a bond of computers and tuned to deliver large amounts of computational power to allow parallel processing of independent computational jobs. For more information, see `this Wikipedia entry `_. http .. index:: protocol; http @@ -448,7 +447,7 @@ Glossary pipe .. index:: ! operating system concept; pipe - Unix concept: A mechanism for providing the output of one command (:term:`stdout`) as the input of a next command (:term:`stdin`) in a Unix terminal. The standard syntax are multiple commands, separated by vertical bars (the "pipes", "|"). Read more `on Wikipedia at wikipedia.org/wiki/Pipeline_(Unix) `_. + Unix concept: A mechanism for providing the output of one command (:term:`stdout`) as the input of a next command (:term:`stdin`) in a Unix terminal. The standard syntax are multiple commands, separated by vertical bars (the "pipes", "|"). Read more `on Wikipedia `_. provenance A record that describes entities and processes that were involved in producing or influencing @@ -554,7 +553,7 @@ Glossary Git concept; Squashing is a Git operation which rewrites history by taking a range of commits and squash them into a single commit. For more information on rewriting Git history, checkout section :ref:`history` and the - `documentation at git-scm.com/book/en/v2/Git-Tools-Rewriting-History `__. + `documentation `__. SSH .. index:: concepts; SSH @@ -619,7 +618,7 @@ Glossary Singularity `Singularity `_ is a containerization software that can package software into :term:`software container`\s. It is a useful alternative to :term:`Docker` as it can run on shared computational infrastructure. - Find out more on `Wikipedia at wikipedia.org/wiki/Singularity_(software) `__. + Find out more on `Wikipedia `__. Singularity-Hub `singularity-hub.org `_ was a Singularity container portal. @@ -676,10 +675,10 @@ Glossary You can get a short intro to the terminal and useful commands in the section :ref:`howto`. Ubuntu - A common Linux distribution. `Find more information at ubuntu.com `__. + A common Linux distribution. `More information here `__. UUID - Universally Unique Identifier. It is a character string used for *unambiguous* + Universally Unique Identifier. It is a character string used for *unambiguous*, identification, formatted according to a specific standard. This identification is not only unambiguous and unique on a system, but indeed *universally* unique -- no UUID exists twice anywhere *on the planet*. From bfda5918ca3e1663b8a0b988f530e862fe83b2f1 Mon Sep 17 00:00:00 2001 From: Michael Hanke Date: Wed, 15 Nov 2023 14:04:53 +0100 Subject: [PATCH 2/2] Recover the needed parts from the recent revert --- docs/glossary.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/glossary.rst b/docs/glossary.rst index 4d2c03c22..00ad87404 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -83,7 +83,7 @@ Glossary or checkout. This has advantages: The repository is leaner, it is easier for administrators to perform garbage collections, and it is required if you want to push to it at all times. You can find out more on what bare repositories are and how to use them - `here `__. bash @@ -249,7 +249,7 @@ Glossary .. index:: ! operating system concept; environment variable A variable made up of a name/value pair. Programs using a given environment variable will use its associated value for their execution. - You can find out a bit more on environment variable :ref:`in this Findoutmore `. + See the :ref:`Find-out-more on environment variables ` for details. ephemeral clone .. index:: clone (ephemeral); DataLad concept @@ -281,7 +281,7 @@ Glossary Git A version control system to track changes made to small-sized files over time. You can find out - more about git in `the (free) GitPro book `_ + more about Git in `the (free) GitPro book `_ or `interactive Git tutorials `_ on :term:`GitHub`. git-annex @@ -342,7 +342,7 @@ Glossary high-throughput computing HTC - A computing environment build from a bond of computers and tuned to deliver large amounts of computational power to allow parallel processing of independent computational jobs. For more information, see `this Wikipedia entry `_. + A computing environment build from a bond of computers and tuned to deliver large amounts of computational power to allow parallel processing of independent computational jobs. For more information, see `Wikipedia `_. http .. index:: protocol; http @@ -553,7 +553,7 @@ Glossary Git concept; Squashing is a Git operation which rewrites history by taking a range of commits and squash them into a single commit. For more information on rewriting Git history, checkout section :ref:`history` and the - `documentation `__. + `Git documentation `__. SSH .. index:: concepts; SSH @@ -678,7 +678,7 @@ Glossary A common Linux distribution. `More information here `__. UUID - Universally Unique Identifier. It is a character string used for *unambiguous*, + Universally Unique Identifier. It is a character string used for *unambiguous* identification, formatted according to a specific standard. This identification is not only unambiguous and unique on a system, but indeed *universally* unique -- no UUID exists twice anywhere *on the planet*.