resolve warnings, upgrade dependencies (DEV-2251)

[jnussbaum]

resolves DEV-2251

[linear]

DEV-2251 DSP-DOCS: resolve warnings

When building/serving dsp-docs locally, a lot of warnings appear.

For everyday use, it would be practical if they are resolved, so that the real warnings get more attention.

1. DeprecationWarning pkg_resources

INFO     -  DeprecationWarning: pkg_resources is deprecated as an API
              File "/opt/homebrew/lib/python3.11/site-packages/mike/mkdocs_plugin.py", line 6, in <module>
                from pkg_resources import iter_entry_points
              File "/opt/homebrew/lib/python3.11/site-packages/pkg_resources/__init__.py", line 121, in <module>
                warnings.warn("pkg_resources is deprecated as an API", DeprecationWarning)

→ Upstream issue that is already fixed but awaits a release. See jimporter/mike#148

2. DSP-API/00-release-notes/index.mdcontains a link to '.'

This warning appears several times:

WARNING  -  Documentation file 'DSP-API/00-release-notes/index.md' contains a link to '.' which is not found in the documentation files.

The content of DSP-API/00-release-notes/index.md is:

{%
   include-markdown "../../CHANGELOG.md"
%}

The link is invalid, because CHANGELOG.md is located one level further up: "../../../CHANGELOG.md".

To make it even more confusing: there is no "00-release-notes" on docs.dasch.swiss, but rather a "09-release-notes" that I can't find in the repo: https://docs.dasch.swiss/2023.05.03/DSP-API/09-release-notes/ 🤷‍♂️

3. Pages missing in the nav

INFO     -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
              - DSP-API/Readme.md
              - DSP-API/architecture/README.md
              - DSP-API/architecture/decisions/0001-record-architecture-decisions.md
              - DSP-API/architecture/decisions/0002-change-cache-service-manager-from-akka-actor-to-zlayer.md
              - DSP-API/architecture/decisions/0003-change-iiif-service-manager-and-sipi-implementation-to-zlayer.md
              - DSP-API/architecture/decisions/0004-change-respondermanager-to-a-simple-case-class.md
              - DSP-API/architecture/flows/http-request-flow.md
              - DSP-APP/user-guide/publication.md

marcin.procyk: Have you got an idea how to resolve no. 2 or no. 3?

4. Missing git logs for ALL files

One example:

WARNING -  DSP-TOOLS/file-formats/json-project/caveats.md has no git logs, revision date defaulting to today's date

For no single md file in all 3 repos, there is a git log. You can click through every page of API, APP, TOOLS on https://docs.dasch.swiss/2023.05.03, and every file says on the bottom: Last update: 2023-06-01.

I think the problem is that https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin cannot be used in a monorepo.

However, if we use https://github.com/timvink/mkdocs-git-revision-date-localized-plugin, it works:

mkdocs.yml:

plugins:
  - git-revision-date-localized    <-- works, must be on top
  - mike
  - monorepo
  - include-markdown
  - search
  - git-revision-date              <-- doesn't work (regardless of position)

[mpro7]

Looks OK. It would be nice to know if things are still working while releasing the docs. This will be check tomorrow I think ;)