Re: [udig-devel] udig.github.com doc deployment as a draft

[Frank Gasdorf <fgdrf@xxxxxxxxxxxxxxxxxxxxx>]

Thank your for the conversion of Walkthrough 2, had seen that the
files are without spaces ;)

.. and you have won a free weekend, because yesterday night I finished
walkthrough 2 (separate chapters):
http://udig.github.com/docs/user/getting_started/walkthrough2/index.html
and a page with all chapters together :
http://udig.github.com/docs/user/getting_started/walkthrough2/walkthrough2.html

Please proofread the chapters (formatings and arrangement) as well as
structure of docs.

fixed the missing images (extracted from udig-docs otd files) and
added some formatings like menuselection, guilabel, some notes and
hints. I left out :command: and :kbd: up to now and would like to add
it later. I'm not sure how to deal with elements like layer and map
names - some are emphesized with **My Label** some make use of
:guilabel:
I would prefer :guilabel: only for fix elements like View Names,
Dialog Buttons and everything that not dependents on content. Should
we just use a bold style to deal with (dynamic) names?

At this point I would like to create a "documentation" doc where we
describe the directives we can use and some best practices. A good
example can be found at geoserver developer guide we can start with:
http://docs.geoserver.org/trunk/en/docguide/sphinx.html

In addition I will create a page where we can see the conversion
process and how we get the converted docs into udig.github.com

Cheers,
Frank



2012/6/21 Jody Garnett <jody.garnett@xxxxxxxxx>:
> Thanks so much Frank!
>
> I had read about nojekyll but did not understand that it would effect us -
> good debugging! I have pushed up an initial conversion of walkthrough 2, and
> will get back to fixing images this weekend.
>
> Exciting!
> --
> Jody Garnett
>
> On Wednesday, 20 June 2012 at 5:14 PM, Frank Gasdorf wrote:
>
> 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
> _______________________________________________
> User-friendly Desktop Internet GIS (uDig)
> http://udig.refractions.net
> http://lists.refractions.net/mailman/listinfo/udig-devel
>
>