Hi, Great! Sounds good to me: a link to the Javadoc for download is enough. I tend to think that the best place to read Javadoc is in your IDE (not in a browser). I've also pushed some of the guidelines defined in https://wiki.jasig.org/display/CAS/CAS+Threat+Modeling into the Github pages. Best regards, Jérôme
2014-02-03 Misagh Moayyed <[email protected]>: > I did move a few things around; this is what has happened since the last > update: > > > > 1. The docs are moved to a "current" directory and documentation site is > organized to keep track of changes per each release. At release time, we > can just grab a copy of "current" and move it over to "x.y.z". > > 2. I had to jump through a few hoops to get the sidebar working per each > version. Documented it all on the README. > > 3. Also added a header link that would point to earlier versions of the > documentation per release. Probably not the best location choice, but I > didn't obsess too much about that. > > 4. I also added sections for Code Conventions and Release Process under > the "Developer" heading. > > 5. Build is now automated. (See the build.[sh.bat] files) > > > > Tasks left to do: > > 1. Update the project README to point to the pages > > 2. Announcements on the wiki that it has been "officially" retired. Points > to the new pages > > 3. Drop the "documentation" module > > > > Now onto Javadocs and having looked at the current build and size of the > generated docs, I'd propose that instead of actually maintaining the docs > we'd just add links to sonatype where docs can be downloaded as jars. Size > of the javadocs for all modules is just going to grow increasingly per each > release (I am looking at my staging directory that is about 430MB) and it > would just make maintenance and downstream pulls difficult. (Although we > could potentially do sparse checkouts) > > > > Unless there are other services that we can push javadocs onto, I am not > sure having them in the branch would be feasible in the long run. > > > > *From:* Jérôme LELEU [mailto:[email protected]] > *Sent:* Tuesday, January 28, 2014 8:40 AM > *To:* [email protected] > *Subject:* Re: [cas-dev] CAS 4.0 Documentation > > > > Hi, > > > > I pushed the "Delegate authentication" part today. > > Best, > > Jérôme > > > > > > 2014-01-27 Marvin Addison <[email protected]> > > > - On javadocs, I think we can simply generate the docs on the master > branch > > and move them over to a "javadocs" directory of the gh-pages branch. > > I've done that for another project and can confirm it's feasible. I > think some tooling around generate/copy to branch/commit might make > long-term maintenance easier, but a manual process should be suitable > for the time being. > > > - On versions, since branching doesn't quite work with github pages it > might > > make sense to move everything under a "previous" directory of some sort > > I would think it's more commonplace to have a "current" folder that > symlinks to the latest version as with download sites. Then we simply > have a list of folders for each version. The index.html main page > would be a permanent symlink to current/index.html such that only the > current directory symlink changes with each new published version. > > M > > -- > 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-dev > > > > -- > 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-dev > > -- > 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-dev > > -- 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-dev
