[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [udig-devel] doc conversion to Sphinx and RST
|
Frank it seems we are both trying to go in the same direction; I encourage us to *start* and we can figure out the details as we go.
I will take your direction for a "single source documentation" to aid in translation; and we will need to figure out how copy out the good bits to the correct location after.
USER GUIDE
- "online help" currently available at http://udig.refractions.net/confluence/display/EN/Home is what I refer to as the "user guide"
- one of the sections in the user guide consists of "getting started" which consists of PDFs that can printed for use offline
- this is extracted out of the wiki and processed into eclipse help which is stored in net.refractions.udig.help/en/docs.zip
- additional languages are each captured in their own wiki
DEVELOPERS GUIDE
- the developers guide available at http://udig.refractions.net/confluence/display/DEV/Home
- the "Getting Started" sections of the developers guide consists of PDFs that can be printed for use offline
- this is extracted out of the wiki and processed into eclipse help which is stored in net.refractions.udig.dev/docs.zip
- the developers guide has never been translated
WEBSITE
- currently generated using PHP and held in subversion; we could migrate this to git
- pmc members have commit access if you need anything changed
Q: Do you want the "single source documentation" to include bother the user and developers guide?
Okay it looks like other projects are handling it that way. We can always put a step in our build script that packages up the generated html into a "docs.zip" during deploy.
Example from GeoServer:
doc/en/developer
doc/en/user
doc/en/docguide
doc/en/theme
doc/es/user
doc/fr/theme
doc/fr/theme
Example from OSGeoLive:
doc/en
doc/fr
doc/dr
doc/theme
--
Jody Garnett
On Friday, 11 May 2012 at 5:02 PM, Frank Gasdorf wrote:
I'm not sure about the new location. I had something different in my
mind but lets sort it. I would prefer a single source documentation
where the content for the online help (both eclipse and really online
a multi-language system (like OSGeo live does) to support
translations.
Single source means also in combination with program code sources
(java, xml, etc). 1+ for udig-platform. Within the repository a root
doc folder would be the entrance fro documentations, independent from
target (user/developer, offline walk-through pdfs/eclipse help for
Is it possible to extract user documentation from confluence wiki for
the integrated eclipse help? The wiki has the advantage that potential
non programmers haven not to deal with source checkout and obstacles
like git fetches/pull's/push's. How likes to help in user docs just
need a wiki account, nothing else ..
You see, I'm torn between developer friendly single source system and
be open for contribution from end-users and non developers without any
technical obstacles.
What about you?
Frank
With that in mind the correct locations should be:
- plugins/net.refractions.udig.help (for user docs)
- extras/net.refractions.udig.dev (for developers guide; although I think we
could move this to plugins in order to fold it into the maven command line
build)
