<div>
Hi,
</div><div><br></div><div>I added to the gatein-api-java project the generation and publishing of javadoc to GitHub pages (known as gh-pages). For the gatein-api-java I added the javadoc generation of the API and the publishing to the gh-pages so it's possible to publish the javadoc to make it visible to others.</div><div><br></div><div>gh-pages are useful for generating static content from a project (like javadoc) and deploying it with little efforts quickly, here is how it works for the gatein-api-java:</div><div><br></div><div>1/ the maven javadoc plugin generates the javadoc for the api module (which is the one we care about).</div><div>2/ gh-pages uses a special branch of a git repository called "gh-pages" that contains the site.</div><div>3/ there is a special github plugin that publish a directory to the gh-pages</div><div>4/ github receives pushes on the gh-pages and publishes them on the web</div><div><br></div><div>In practice it means that:</div><div>- doing "mvn install -Pgithub" will publish the javadoc in the api module of the gatein-api-java project</div><div>- the project javadoc can be browsed at http://gatein.github.com/gatein-api-java/</div><div><br></div><div>Anybody with push permissions can do it on a repository, however the settings.xml should contain "git" username / password (which can be not acceptable for some ppl but it's possible also to specify that using properties). In practice I'm using it with a profile defined in settings.xml like:</div><div><br></div><div><div> <profile></div><div> <id>github</id></div><div> <properties></div><div> <github.global.userName>vietj</github.global.userName></div><div> <github.global.password>XXXXXXXXX</github.global.password></div><div> </properties></div><div> </profile></div></div><div><br></div><div>So "mvn install -Pgithub" uses them automatically.</div><div><br></div><div>Pointers:</div><div>- http://pages.github.com/</div><div>- https://github.com/github/maven-plugins/</div><div><br></div><div>If you find this useful we should add it to the wiki but I don't know in which community / page add it.</div>
<div><div><br></div><div>Julien Viet</div><div>julienviet.com</div><div><br></div></div>