rdmorganiser / rdmorganiser/rdmo-docs

Documentation Corrections and Enhancements

Open
#59 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Makefile
Stars
0
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Issue: Documentation Corrections and Enhancements
1. Incorrect Description for SOCIALACCOUNT_AUTO_SIGNUP

Under Authentication Documentation:

  • Current Description:
    SOCIALACCOUNT_AUTO_SIGNUP = True forces new users to fill out a signup form even if the provider does provide the email address.

  • Correct Description:
    SOCIALACCOUNT_AUTO_SIGNUP = False forces new users to fill out a signup form even if the provider does provide the email address.

2. Database Initialization Required After Setting OIDC

When choosing OIDC (e.g. Keycloak) as an IDP, the database initialization must be repeated after the allauth Library Installation as described in the Database Initialization Documentation.

3. Mentioning the LOGIN_FORM Parameter

Including a reference to the LOGIN_FORM parameter in the authentication documentation All Auth documentation would be helpful for clarity and completeness.

4. Additional Profile Parameters

The following parameters should also be mentioned in All Auth documentation to clarify their role:

PROFILE_UPDATE = False
PROFILE_DELETE = False
5. TLS Certificate for On-Premise IDP Deployments

For on-premise IDP deployments (e.g. Keycloak), adding the TLS IDP Certificate to Python Packages is necessary unless an alternative implementation is provided by the project maintainers.

  • Example Command:
echo 'COMPANY CA
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----' | sudo tee -a /srv/rdmo/rdmo-app/env/lib/python*/site-packages/certifi/cacert.pem
Suggested Actions
  1. Update the documentation for SOCIALACCOUNT_AUTO_SIGNUP to reflect the correct behavior.
  2. Add a note under OIDC configuration to repeat the database initialization step.
  3. Include references to the LOGIN_FORM, PROFILE_UPDATE, and PROFILE_DELETE parameters for better user guidance.
  4. Provide instructions or a note about adding TLS certificates for on-premise IDP deployments.

Thank you for considering these updates!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Authentication Documentation, especially the social-accounts and django-allauth sections, then review the linked Database Initialization Documentation. Update the SOCIALACCOUNT_AUTO_SIGNUP description, add the requested parameters and OIDC initialization note, and document the on-premise TLS certificate guidance; done means all five suggested actions are reflected accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, python
Domain
authentication, databases, documentation, security
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.