It would be interesting if Confluence or a wiki allowed for pages to be dynamically organized based on tags so you could ask for all material for CAS X.X or X.X.X and it would be smart enough to accumulate it together. * dreaming *
Now that wishful dreaming is out of the way, I think we can admit that having documentation per version is definitely helpful from a user¹s perspective; simply isn¹t efficient from a maintainer perspective. On 7/10/09 12:33 PM, "Scott Battaglia" <[email protected]> wrote: > I thought about that, but there's very little information that changes each > version. We're usually just adding new features. We can probably do a better > job of keeping a changelog in the manual though, as well as specifying minimum > versions on the manual pages. > > I know some places like Atlassian keep separate manuals per version, but then > they also pay documentation writers... ;-) I'm also not sure how well our > instance of Confluence would hold up with lots of new pages. I also don't > want to be the one correcting errors on multiple pages ;-) > > > > On Fri, Jul 10, 2009 at 1:29 PM, Andrew Feller <[email protected]> wrote: >> M, >> >> Does it make sense to restructure the CAS User Manual section of the wiki >> based upon version / series of CAS being deployed? I have been thinking >> about this sometime as I was the one who started the "Deploying CAS 3.0.x >> ..." page a few years ago. >> >> The reason I bring it up is that some information is: >> >> 1) Particular for a minor series (3.0.X, 3.1.X, etc) >> 2) Particular for a major series (3.X, 4.X, etc) >> >> I am not saying I have a fully fleshed out plan for dealing with information >> that crosses series, but I like some thoughts on the idea. >> >> Thanks for the good work, >> A- >> >> On 7/10/09 11:09 AM, "Marvin Addison" <[email protected]> wrote: >> >>> > I'm done with Wiki cleanup. I would sincerely appreciate some >>> > community review and feedback. Summary of changes: >>> > >>> > - Added high-level overview text on Home page >>> > - Added "Security Policy" section and added "Ticket Expiration Policy" >>> > page and moved "Remember Me" page there >>> > - Moved a number of pages from the "Troubleshooting" section to the >>> > "Tutorials and HOWTOs" section and tried to clarify titles >>> > - Added content to "SAML 1.1" protocol page >>> > - Added "Shibboleth-CAS Integration" page >>> > - Added some text to a number of section header pages >>> > >>> > Some points for consideration: >>> > >>> > - I was concerned about disagreement between some claims I made in the >>> > "Availability" section of the home page and the "Clustering" page. >>> > From my experience with JpaTicketRegistry, all you need for high >>> > availability is an active-active load balanced setup and a distributed >>> > registry. The "Clustering" page has a number of additional concerns. >>> > >>> > - Consider consolidating "Deploying CAS 3.0.x in RHEL 5 with Sun Java" >>> > with "HOWTO Switch to Sun JVM in RHEL" or delete for former >>> > altogether. >>> > >>> > - Delete the following pages as their content is covered elsewhere: >>> > - "HOWTO Configure Single Sign On Session Timeout" (covered in >>> > "Ticket Expiration Policy") >>> > - "How to Fedora 10 + CAS 3.3.1 + OpenLDAP 2.4.12 + DIGEST-MD5" >>> > (covered in last example on "LDAP") >>> > >>> > - Search and destroy duplicated content. I caught some, but it will >>> > take a thorough review to catch it all. Duplicated content is an >>> > editorial nightmare, and, as such, content convered in multiple places >>> > is frequently in disagreement. Conflicting documentation is worse >>> > than no documentation at all. >>> > >>> > M >> >> -- >> Andrew Feller, Analyst >> LSU University Information Services >> 200 Frey Computing Services Center >> Baton Rouge, LA 70803 >> Office: 225.578.3737 >> Fax: 225.578.6400 >> >> >> >> -- >> You are currently subscribed to [email protected] as: >> [email protected] >> To unsubscribe, change settings or access archives, see >> http://www.ja-sig.org/wiki/display/JSG/cas-user -- Andrew Feller, Analyst LSU University Information Services 200 Frey Computing Services Center Baton Rouge, LA 70803 Office: 225.578.3737 Fax: 225.578.6400 -- You are currently subscribed to [email protected] as: [email protected] To unsubscribe, change settings or access archives, see http://www.ja-sig.org/wiki/display/JSG/cas-user
