Re: Publishing api docs for Subversion
On Fri, Dec 4, 2009 at 4:23 AM, Hyrum K. Wright hyrum_wri...@mail.utexas.edu wrote: On Dec 3, 2009, at 2:14 PM, Paul Querna wrote: On Thu, Dec 3, 2009 at 9:31 AM, Doug Cutting cutt...@apache.org wrote: Paul Querna wrote: httpd and apr have published doxygen of their trunks periodically, they aren't based on any release. Were these published these on the official public website or in the dev/ section? I was under the impression that released documentation should be treated similarly to released code. The convention I've used is that stuff that's in trunk, stuff that's intended to be included in releases, is only published after release. Other pages on the website that are not included in releases, e.g., the project's home page, are clearly published without a release vote. http://httpd.apache.org/docs/trunk/ Which is linked from the sidebar everywhere, and on the docs page: http://httpd.apache.org/docs/ Back the original question: What's the best/typical way of generating and providing these documents? Subversion is using svnwcsub to publish subvesion.apache.org, but I don't think it's reasonable to check in a copy of the API documentation. To add to it and if i was not clear in my original email, when I say update docs on nightly basis, I mean updating the files every night. It does not mean generating new set of doc files every night. Overall we'll maintain just one copy that is updated every night. I wish there should be a place other that site/ area in repository, if people.apache.org is not apt. -- Regards, Bhuvaneswaran A www.livecipher.com GPG: 0x7A13E5B0 - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Publishing api docs for Subversion
On Fri, Dec 4, 2009 at 2:12 PM, Jukka Zitting jukka.zitt...@gmail.com wrote: Some Apache projects are now using Hudson builds to generate their web sites from sources stored in svn. The generated site is periodically rsynced to the correct place people.apache.org. This setup is still a bit experimental but should cover your needs pretty well. Thanks for sharing your views, Jukka. Thinking deeper into this task, the Hudson has a inbuilt feature to publish html content if placed in userContent folder. The javadoc publishing capability is already present in Hudson. Taking advantage of both these Hudson features, I'm thinking a) configure the job(s) to generate doxygen and javadoc documentation. b) create a link to this document to userContent. With this setup, the documentation can be made available here: doxygen: http://hudson.zones.apache.org/hudson/userContent/subversion/doxygen/index.html javadoc: http://hudson.zones.apache.org/hudson/userContent/subversion/javadoc/index.html We may configure this job to run on daily basis. AFAIK, in the past we did not publish doxygen/javadoc for stable releases in Subversion project. If we had to so, we may place them in svn under site/ directory corresponding to that release. The documentation for trunk aka. on going changes can be made available in the above url which we may link it from our home page, if need be. To publish document in this fashion, all we need to do is create Hudson job(s) appropriately. I'll propose this plan to our project team and do the setup accordingly. Thank you! -- Regards, Bhuvaneswaran A www.livecipher.com GPG: 0x7A13E5B0 - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Publishing api docs for Subversion
Here's a query related to publishing api docs for Subversion project periodically. We tend to update the api docs generated using doxygen and java doc on a nightly basis. We are evaluating a workaround to publish it periodically. Based on investigation I did so far, most of projects namely apr, hadoop, jakarta seem to place the apidocs in site/ area, not updated periodically though. As our use case is to update periodically, we wouldn't want to commit the auto generated docs in asf repository often. Considering these aspects, here's what we are planning to do: Setup a Hudson job in hudson.zones.apache.org farm that would generate the documentation using doxygen and javadoc. This can be setup to run periodically, may be once a day or once a week. Then, push the documentation files to people.apache.org into one of our accounts using SCP plugin that is already available in Hudson. We may use a passphrase/keyfile for authentication. Please shed some light if this is not the right approach, and/or if you could suggest a better/alternate approach, that would be helpful. -- Regards, Bhuvaneswaran A www.livecipher.com GPG: 0x7A13E5B0 - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
