Warning: Can't synchronize with repository "(default)" (Unsupported version control system "svn": No module named svn). Look in the Trac log for more information.

Ticket #1812 (closed documentation: fixed)

Opened 10 years ago

Last modified 8 years ago

Document advanced identity features in docstrings and wiki

Reported by: Chris Arndt Owned by: Chris Arndt
Priority: high Milestone: 1.1
Component: Documentation Version: 1.0.4.4
Severity: normal Keywords: identity, doc request
Cc:

Description

Some of the advanced features of the identity framework are currently poorly documented or not at all, e.g.

  • Setting identity.failure_url to a callable
  • Creating custom identity predicates
  • Creating custom identity exceptions
  • Handling identity error messages

We should document these in source code docstring in the turbogears.identity package and the  Identity docs in the wiki.

Relevant mailing list thread:

 No redirect when not enough credentials (Tiny URL:  http://tinyurl.com/5p6zus)

Change History

comment:1 Changed 9 years ago by faide

  • Milestone changed from 1.1 to 1.1.1

comment:2 Changed 9 years ago by faide

  • Milestone changed from 1.6 to 1.5

comment:3 Changed 9 years ago by Chris Arndt

  • Status changed from new to assigned

Also document using a custom password encryption algorithm.

comment:4 Changed 9 years ago by Chris Arndt

  • Milestone changed from 1.5 to 1.1

I made some progress on this and created an example project that demonstrates most of the above listed features, except using custom identity exceptions, which is already explained on the  using identity page and the custom password encryption algorithm, for which I added some documentation in the  identity configuration reference.

I attached the sample project to the  identity recipes page and will add a description later.

comment:5 Changed 8 years ago by Chris Arndt

  • Type changed from task to documentation

comment:6 Changed 8 years ago by Chris Arndt

  • Status changed from assigned to closed
  • Resolution set to fixed

I have added another page on  using an identity failure URL callable and linked it to the identity recipes page. I also enhanced the section on implementing a custom identity provider on the latter page. This now covers all the items mentioned in the summary plus some. I'm therefor closing this ticket as fixed.

Note: See TracTickets for help on using tickets.