Project

General

Profile

Support #5455

Update documentation

Added by Benjamin Dauvergne almost 5 years ago. Updated over 3 years ago.

Status:
Nouveau
Priority:
Normal
Assignee:
Gestion d'identité
Category:
Documentation
Target version:
Start date:
03 Dec 2014
Due date:
% Done:

0%

Patch proposed:
No
Planning:
No

Description

Documentation is currently out of date, a new toc should be made, obsolete sections should be removed or moved to externalised plugins and obsolete informations should be fixed.


Subtasks

Support #6047: Section fonctionnement des settingsNouveauBenjamin Dauvergne

Support #6048: Complete the section settings listNouveauBenjamin Dauvergne

Support #6049: Update references to settingsNouveauBenjamin Dauvergne

Support #6050: Update upgrading sectionNouveauBenjamin Dauvergne

Support #6051: Remove the FAQ style (rewrite section title written as question)Nouveau

Support #6052: Rewrite attribute sectionNouveauBenjamin Dauvergne

Support #6053: Write a quick start note for oauth2 idpNouveauBenjamin Dauvergne

Support #6054: Write a quick start note for saml2 sp - google apps use caseNouveauSerghei Mihai

Support #6055: Check the section on how policy worksNouveauBenjamin Dauvergne

Support #6056: Add a section on user regsitration and emailingNouveauBenjamin Dauvergne

Support #6057: Write a quick start note for saml2 idpNouveauBenjamin Dauvergne

Associated revisions

Revision e5ebc662 (diff)
Added by Mikaël Ates over 4 years ago

documentation: refactor documentation (refs #5455).

Revision c3f8d5fe (diff)
Added by Mikaël Ates over 4 years ago

documentation: remove old documentation files (refs #5455)

History

#1 Updated by Benjamin Dauvergne almost 5 years ago

  • Assignee changed from Benjamin Dauvergne to Thomas Noël

#2 Updated by Benjamin Dauvergne over 4 years ago

Sections needing an update:
  • settings (they are not fully covered, we should try to use directly the app_settings.py files to generate that doc if possible, to keep it covered at all times)
  • LDAP as django-auth-ldap is not used anymore
  • attribute management for SAML (attribute aggregator being deprecated)
Missing sections:
  • basic user and group management using the new manager
  • definition of attributes
  • plugin system (how to make a plugin, what are the available hooks, idp interface and authentication frontend interface)
  • Kerberos authentication (it's an external plugin but maybe should-it be integrated)
  • OAuth2 IdP (idem)
  • settings around self-servicef of users: my account, registration page, federation management, a kind of end-user manual.

More than work on specific topics what's needed it a reorganization, first installation&configuration, then usual management then advanced topics.

I have an initial proposal:

  • Overview
    • Features
    • Source and issue tracker
    • Community support
  • Installation
    • Installing (lasso&pip|debian)
    • Creating and initializing the db
    • Creating admin users
    • Running with apache/nginx & serving static files
  • Configuration
    • Internal Django directory
      • Realms
      • Custom attributes
    • LDAP authentication
      • Realms
      • OpenLDAP case
      • AD case
      • Generic case (full description of the settings)
    • Kerberos authentication
    • CAS Authentication
    • Sessions&cookies
    • User self-service
      • Registration page
      • Password change
      • Profile page
    • SAML IdP settings
    • OAuth2 IdP settings
    • CAS IdP settings
    • OpenID IdP settings
    • Other settings
  • Day to day management
    • Managing users
    • Managing roles/groups
    • Managing SAML service provider
    • Managing OAuth2 service providers
    • Managing CAS service providers
    • Backup and restore
      • using fixtures
      • using pg_dump / psql
  • Advanced topics
    • Debugging
      • DEBUG=True
      • DEBUG_LOG
      • debug-toolbar
    • Writing plugins
      • IdP backend interface
      • Frontend interface
      • Authentication backends

We should not just document what exists, when existing is too difficult to document it should be changed. Separation between LibertyProvider, LibertyServiceProvider, SPOptionsIdPPolicy, LibertyProviderPolicy and AttributePolicy are artificial and should be removed. There should be only one object, SAMLServiceProvider that inherits from an abstract SAMLServiceProviderPolicyBase and can be linked to a concrete SAMLServiceProviderPolicy also.

#3 Updated by Benjamin Dauvergne over 4 years ago

  • Assignee changed from Thomas Noël to Gestion d'identité

#4 Updated by Benjamin Dauvergne over 4 years ago

  • Category set to Documentation

#5 Updated by Benjamin Dauvergne over 4 years ago

  • Target version set to future

#6 Updated by Benjamin Dauvergne over 3 years ago

  • Target version changed from future to 2.2.0

Also available in: Atom PDF