Skip to content

Commit

Permalink
Allow GitHub URLs to resolve - linkcheck (#443)
Browse files Browse the repository at this point in the history
Enable GitHub URLs to link to specific `.md` files which should resolve
`make linkcheck` issues by allowing them to be ignored - see pattern
described in #440
  • Loading branch information
eviau-artefactual authored Feb 21, 2024
1 parent 1431d1d commit 9308f81
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -159,5 +159,5 @@ environment itself.
.. _ClamAV manual pages: https://manpages.debian.org/jessie/clamav-daemon/clamd.conf.5.en.html
.. _Compose .yml file: https://github.com/artefactual/archivematica/blob/qa/1.x/hack/docker-compose.yml
.. _configuration file: https://github.com/artefactual-labs/ansible-clamav/blob/master/defaults/main.yml
.. _Ansible environment variables: https://github.com/artefactual-labs/ansible-archivematica-src/blob/stable/1.15.x/README.md#environment-variables
.. _Ansible environment variables: https://github.com/artefactual-labs/ansible-archivematica-src/blob/d4474c3dbaef2b561c87e0650c6ee386be6910a7/README.md#environment-variables
.. _Bug 11958: https://bugzilla.clamav.net/show_bug.cgi?id=11958
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ to create (and check) than the alternatives (e.g. SHA-256).

.. _MCPServer: https://github.com/artefactual/archivematica/tree/6ead2083f7bdd8b10ca76d41a7bff9c5aee23eb3/src/MCPServer/install
.. _MCPClient: https://github.com/artefactual/archivematica/tree/6ead2083f7bdd8b10ca76d41a7bff9c5aee23eb3/src/MCPClient
.. _MCPClient concurrency: https://github.com/artefactual/archivematica/tree/3e52494735ebfeb0cabc477d95d692034f4b3142/src/MCPClient#concurrency
.. _MCPClient concurrency: https://github.com/artefactual/archivematica/blob/3e52494735ebfeb0cabc477d95d692034f4b3142/src/MCPClient/README.md#concurrency
.. _systemd: https://en.wikipedia.org/wiki/Systemd
.. _unit file: https://www.freedesktop.org/software/systemd/man/systemd.unit.html
.. _MCPClient unit file: https://raw.githubusercontent.com/artefactual-labs/am-packbuild/qa/1.x/rpms/EL9/archivematica/etc/archivematica-mcp-client.service
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ In order to obtain valid SSL certificates trusted by any browser, you can use

:ref:`Back to the top <install-advanced>`

.. _`development environment instructions`: https://github.com/artefactual/archivematica/tree/qa/1.x/hack#archivematica-development-on-docker-compose
.. _`development environment instructions`: https://github.com/artefactual/archivematica/blob/qa/1.x/hack/README.md
.. _`sample configurations for the dashboard`: https://github.com/artefactual-labs/ansible-archivematica-src/blob/8b2aee1ba90053d030c31f3b8d0e5b0f14fcf57c/templates/etc/nginx/sites-available/dashboard-ssl.conf.j2
.. _`sample configurations for the Storage Service`: https://github.com/artefactual-labs/ansible-archivematica-src/blob/8b2aee1ba90053d030c31f3b8d0e5b0f14fcf57c/templates/etc/nginx/sites-available/storage-ssl.conf.j2
.. _`Let's Encrypt`: https://letsencrypt.org
Original file line number Diff line number Diff line change
Expand Up @@ -146,5 +146,5 @@ steps:
:ref:`Back to the top <install-ansible>`

.. _`deploy-pub`: https://github.com/artefactual/deploy-pub
.. _`ansible-archivematica-src`: https://github.com/artefactual-labs/ansible-archivematica-src/tree/d4474c3dbaef2b561c87e0650c6ee386be6910a7#disable-elasticsearch-use
.. _`ansible-archivematica-src`: https://github.com/artefactual-labs/ansible-archivematica-src/blob/d4474c3dbaef2b561c87e0650c6ee386be6910a7/README.md#disable-elasticsearch-use
.. _`Vagrant website`: https://www.vagrantup.com/downloads.html
4 changes: 2 additions & 2 deletions admin-manual/installation-setup/integrations/binder-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ section :ref:`Upload a DIP to Binder <upload-binder>`.

.. _Binder documentation: https://binder.readthedocs.io/en/latest/user-manual/overview/project-status.html
.. _Binder GitHub repository: https://github.com/artefactual/binder
.. _installation instructions: https://github.com/artefactual/binder/tree/a2893fe589c67f147de440a52301c4025ad1cd4e#installation
.. _configuration instructions: https://github.com/artefactual/binder/tree/a2893fe589c67f147de440a52301c4025ad1cd4e#configuration
.. _installation instructions: https://github.com/artefactual/binder/blob/a2893fe589c67f147de440a52301c4025ad1cd4e/README.md#installation
.. _configuration instructions: https://github.com/artefactual/binder/blob/a2893fe589c67f147de440a52301c4025ad1cd4e/README.md#configuration
2 changes: 1 addition & 1 deletion admin-manual/installation-setup/upgrading/upgrading.rst
Original file line number Diff line number Diff line change
Expand Up @@ -563,4 +563,4 @@ the databases and their tables.
.. _`Elasticsearch 6.8 docs`: https://www.elastic.co/guide/en/elasticsearch/reference/6.8/modules-snapshots.html
.. _`release notes`: https://wiki.archivematica.org/Release_Notes
.. _`Reindex API`: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
.. _`es-reindex.sh`: https://github.com/artefactual-labs/ops-helpers/tree/master/es-helpers#es-reindexsh-update-search-indices
.. _`es-reindex.sh`: https://github.com/artefactual-labs/ops-helpers/blob/master/es-helpers/README.md#es-reindexsh-update-search-indices
2 changes: 1 addition & 1 deletion user-manual/transfer/import-metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ This feature is disabled by default. It's still considered experimental and
its validation rules need to be configured according to the user needs before
using it.

The `Metadata XML validation variables <https://github.com/artefactual/archivematica/tree/179247f9e5508defd563e4eae3c73ea8e8b674f3/src/MCPClient/install#metadata-xml-validation-variables>`_
The `Metadata XML validation variables <https://github.com/artefactual/archivematica/blob/179247f9e5508defd563e4eae3c73ea8e8b674f3/src/MCPClient/install/README.md#metadata-xml-validation-variables>`_
section of the MCPClient installation documentation explains how to enable
and configure this feature. You can also check the
`sample configuration files <https://github.com/artefactual/archivematica-sampledata/tree/b01539902198a9e4a15f76add7b6b129eecf6b7b/xml-validation>`_
Expand Down

0 comments on commit 9308f81

Please sign in to comment.