Hi, On Wed, Jan 11, 2012 at 4:23 PM, Patrick Mueller <[email protected]> wrote: > Let's assume it's the CMS. And that we will continue to programmatically > generate the API doc. What does that process look like? doc maintained in > git, then a build process pulls that, runs it's build, then publishes to > the CMS. Do we have to go through SVN, the staging server, and then the > actual server?
See [1] for the recommended way of publishing generated stuff with the Apache CMS. Note that usually the official project site only contains static documentation for existing releases of the product. Actively developed documentation that refers to the latest trunk can reside elsewhere like on a build server [2] or a wiki, and be just referenced from the main project site. > For 1), I know about wikis and the CMS. That's it, right? As mentioned above, documentation generated from sources in git or svn can also be located on a build server for developer use. For example the generated javadocs of the latest Apache OpenCMIS trunk are available at [3]. > I guess we need to factor in that we still ship doc in the > releases as well. As noted by Ross earlier, anything that gets included in the release packages we ship needs to be traceable back to a committer (and thus an ICLA), which rules out an open wiki as the source repository for such documentation. [1] http://www.apache.org/dev/cmsref.html#generated-docs [2] http://ci.apache.org/ [3] https://builds.apache.org/job/Chemistry%20-%20OpenCMIS%20-%20javadoc/javadoc/ BR, Jukka Zitting
