Readthedocs released a security warning, GHSA-qhqx-5j25-rv48.
Our docs are affected due to the https://github.com/readthedocs/readthedocs-sphinx-search package.

Search could be hosted by readthedocs instead.

recommonmark is deprecated. The recommended replacement is myst-parser.

config/settings/base.py, which is part of the git repository.

-> I think content of base.py is now in init.py

The steps in the release docs are outdated:

https://github.com/rdmorganiser/rdmo-docs-en/blob/cd79dc95dd800fddc4747caddd21e4750cea5bb0/docs/development/releases.md?plain=1#L21

python setup.py sdist bdist_wheel should be python -m build. I will open an issue in the docs repo.

The shibboleth docs

• the installation of the fork solves a bug with encoding by shibboleth and should be documented
  * NFDI AAI as another alternative to a shibboleth set up

A keycloak instance with a satosa proxy was used to enable a login to rdmo via shibboleth or orcid.
Infos about the settings and setup in rdmo should be added here in the docs.

docs:

• docs/administration/allauth.md
• docs/configuration/authentication/allauth
• docs/configuration/authentication/shibboleth

I think the last merged PR is not yet deployed to https://rdmo.readthedocs.io/, there is no mention of "Keycloak" yet https://rdmo.readthedocs.io/en/latest/search.html?q=keycloak&check_keywords=yes&area=default.

• latest build failed: https://readthedocs.org/projects/rdmo/builds/18108499/

Suggestion: It would be easier to have here a pipeline installed via the Github Actions or via a webhook integration:

• https://docs.readthedocs.io/en/stable/integrations.html#github

Dear all,

Should it not be "REMOTE_USER" instead of "REMOTE_SERVER" in docs/configuration/authentication/shibboleth.md?

Thanks & kind regards
Jörg Steinkamp

Dear @jochenklar

as discussed in the train on Friday, I'm opening an issue for this...

After being enlighted by the workshop about the correct usage of the catalog, etc. I want to rise an issue and complain about missing documentation for maintainers of an RDMO instance.

Currently, there is a lot of technical documentation available, but the different pitfalls while trying to setup an instance for production use is missing a lot of details.

I am willing to contribute here as we go on within FZJ. (Mentioning @bronger)

Cheers,
Oliver

Tried to run rdmo locally with Python 3.8, 3.9., 3.10 and each time, installation fails with django-allauth:

(venv) klav@clt-mob-v-6095 rdmo-app % pip install --upgrade pip setuptools
Requirement already satisfied: pip in ./venv/lib/python3.8/site-packages (21.3.1)
Collecting pip
Using cached pip-22.0.4-py3-none-any.whl (2.1 MB)
Requirement already satisfied: setuptools in ./venv/lib/python3.8/site-packages (60.2.0)
Collecting setuptools
Using cached setuptools-61.0.0-py3-none-any.whl (1.1 MB)
Installing collected packages: setuptools, pip
Attempting uninstall: setuptools
Found existing installation: setuptools 60.2.0
Uninstalling setuptools-60.2.0:
Successfully uninstalled setuptools-60.2.0
Attempting uninstall: pip
Found existing installation: pip 21.3.1
Uninstalling pip-21.3.1:
Successfully uninstalled pip-21.3.1
Successfully installed pip-22.0.4 setuptools-61.0.0
(venv) klav@clt-mob-v-6095 rdmo-app % pip install rdmo
Collecting rdmo
Using cached rdmo-1.8.0-py3-none-any.whl (1.6 MB)
Collecting defusedcsv~=1.1.0
Using cached defusedcsv-1.1.0-py3-none-any.whl (7.5 kB)
Collecting jsonfield~=3.1.0
Using cached jsonfield-3.1.0-py3-none-any.whl (8.0 kB)
Collecting pytest-pythonpath~=0.7.3
Using cached pytest_pythonpath-0.7.4-py3-none-any.whl (3.7 kB)
Collecting django-compressor==2.4.1
Using cached django_compressor-2.4.1-py2.py3-none-any.whl (145 kB)
Collecting iso8601~=0.1.14
Using cached iso8601-0.1.16-py2.py3-none-any.whl (10 kB)
Collecting djangorestframework~=3.12.4
Using cached djangorestframework-3.12.4-py3-none-any.whl (957 kB)
Collecting django-rest-swagger~=2.2.0
Using cached django_rest_swagger-2.2.0-py2.py3-none-any.whl (495 kB)
Collecting django-cleanup~=5.2.0
Using cached django_cleanup-5.2.0-py2.py3-none-any.whl (9.9 kB)
Collecting drf-extensions~=0.7.0
Using cached drf_extensions-0.7.1-py2.py3-none-any.whl (21 kB)
Collecting django-mathfilters~=1.0.0
Using cached django_mathfilters-1.0.0-py3-none-any.whl (5.9 kB)
Collecting django-mptt~=0.12.0
Using cached django_mptt-0.12.0-py2.py3-none-any.whl (111 kB)
Collecting django-extensions~=3.1.3
Using cached django_extensions-3.1.5-py3-none-any.whl (224 kB)
Collecting django-allauth~=0.45.0
Using cached django-allauth-0.45.0.tar.gz (581 kB)
Preparing metadata (setup.py) ... error
error: subprocess-exited-with-error

× python setup.py egg_info did not run successfully.
│ exit code: 1
╰─> [6 lines of output]
Traceback (most recent call last):
File "", line 2, in
File "", line 34, in
File "/private/var/folders/wx/lf0g2dz917lgrk434h0kjftw0000gp/T/pip-install-7z_ux9qg/django-allauth_3cf18744c03e45f295d2cad69096d3cc/setup.py", line 9, in
from setuptools import convert_path, find_packages, setup
ImportError: cannot import name 'convert_path' from 'setuptools' (/Users/klav/work/rdmo/rdmo-app/venv/lib/python3.8/site-packages/setuptools/init.py)
[end of output]

note: This error originates from a subprocess, and is likely not a problem with pip.
error: metadata-generation-failed

× Encountered error while generating package metadata.
╰─> See above for output.

note: This is an issue with the package mentioned above, not pip.
hint: See above for details.
(venv) klav@clt-mob-v-6095 rdmo-app %

The documentation on readthedocs still has 2015-2018 and AIP in the footer:

https://github.com/rdmorganiser/rdmo-docs-en/blob/068696278b7dbb54477ecf71b44903cc3978770d/docs/conf.py#L75

Should this be 2015-2023 RDMO Arbeitsgemeinschaft instead?

There is a link to a non-existing github repository called rdmo-content in the plugins documentation:
https://github.com/rdmorganiser/rdmo-docs-en/blob/883283c8abc6725857e0b1805a5f13fdb40d47a2/docs/plugins/index.md?plain=1#L10

There are a few broken links in the documentation.

Reproduce with:

python -m sphinx -b linkcheck docs html > linkcheck.log
grep broken linkcheck.log

Result:

(administration/allauth: line   18) broken    https://developers.facebook.com/ - 400 Client Error: Bad Request for url: https://developers.facebook.com/
(administration/allauth: line   22) broken    https://apps.twitter.com/app/new - 404 Client Error: Not Found for url: https://developer.twitter.com/en/app/new
(configuration/authentication/allauth: line   67) broken    https://django-allauth.readthedocs.io/en/latest/socialaccount/providers/keycloak - 404 Client Error: Not Found for url: https://docs.allauth.org/en/latest/socialaccount/providers/keycloak
(configuration/authentication/allauth: line   60) broken    http://django-allauth.readthedocs.io/en/latest/providers - 404 Client Error: Not Found for url: https://docs.allauth.org/en/latest/providers
(deployment/gunicorn: line   61) broken    https://example.com/rdmo/ - 404 Client Error: Not Found for url: https://example.com/rdmo/
(management/views: line  283) broken    https://github.com/JessicaTegner/pypandoc#specifying-the-location-of-pandoc-binaries - Anchor 'specifying-the-location-of-pandoc-binaries' not found
(management/user-interface: line    4) broken    https://github.com/rdmorganiser/rdmo-catalog#rdmo-catalog - Anchor 'rdmo-catalog' not found
(   plugins/index: line   49) broken    https://github.com/rdmorganiser/rdmo/blob/master/rdmo/projects/views.py - 404 Client Error: Not Found for url: https://github.com/rdmorganiser/rdmo/blob/master/rdmo/projects/views.py
(deployment/index: line    5) broken    https://github.com/rdmorganiser/rdmo/tree/master/docs - 404 Client Error: Not Found for url: https://github.com/rdmorganiser/rdmo/tree/master/docs

• sphinx-tabs
• sphinx-design

There are a few view classes mentioned here, that don't seem to exist anymore?

• ProjectCreateUploadView,
• ProjectCreateImportView
• ProjectUpdateUploadView
• ProjectUpdateImportView

https://github.com/rdmorganiser/rdmo-docs-en/blob/068696278b7dbb54477ecf71b44903cc3978770d/docs/plugins/index.md?plain=1#L87C10-L87C10

Is this correct?