| Re: [udig-devel] udig.github.com doc deployment as a draft |
Just an update: structure changed a bit: from http://udig.github.com/ you have two links at the top: "USER GUIDE" and "DEVELOPER GUIDE" that refer to http://udig.github.com/docs/user and http://udig.github.com/docs/dev which has no content yet ;) Cheers, Frank 2012/6/20 Frank Gasdorf <fgdrf@xxxxxxxxxxxxxxxxxxxxx>: > Hello everybody! > > Yesterday night I generated the html pages with sphinx after some > content improvements and structure updates. After that I deployed the > content to udig.github.com/user (which was a push to the > https://github.com/uDig/udig.github.com/tree/master/user). > > I hoped that we could use github for doc hostings but unfortunately, > with limited success :( > > ... > > The pages were not displayed correctly because of missing images and > styling stuff. I thought there should be a way to get it working and > found a page about github pages : > https://help.github.com/categories/20/articles > > There seems to be a pre processing step after a push occurred on that > repository master branch. That read I added .nojekyll (see > https://help.github.com/articles/files-that-start-with-an-underscore-are-missing) > file to the root folder and everything looks fine right now. The > reason was that the pre-process doesn't handle folders starting with > an underscore (e.g. _images, _styles, etc). > > > PLEASE note : the current deployment is a draft we can talk about. > Jody is trying some improvements for the user docs conversion from > confluence. Afterwards we will add some entry points for the user docs > as well. > > > Please have a look at http://udig.github.com/user/ > > and the geoserver-install page : > http://udig.github.com/user/getting_started/geoserver/index.html > > were I added > .. note:: and .. hint:: directives > > whereas in http://udig.github.com/user/getting_started/walkthrough1/ImportDirectlytoTheCatalog.html > > you can find .. sidebars:: > > > What do you think about sidebars. Would you prefer having admonitions > like note, warning, hint or even danger with different styles to > emphasize. > > IMHO like the admonitions because of the different styling capability > and after reading some blogs its much better to handle admonitions for > pdf generation (and properly some other document types). > > > Happy reading, > Frank