[Geoserver-devel] Where to put app-schema documentation?

Where should we put end-user documentation for app-schema applications of GeoServer? We have bits and pieces on the seegrid twiki, but this should me migrated either the GeoServer or GeoTools wikis.

app-schema configuration consists largely of creating a data directory, the most tricky part of which is the app-schema mapping file. Because the app-schema mapping file is the configuration file for GeoTools AppSchemaDataAccess, should it be documented in the GeoTools User Guide? This appears to be more aimed at library users, not GeoServer users.

If we do put it in the GeoServer manual, where does it go? I found the 1.7.x manual. Where is the trunk/development manual? Is there a 2.0.x version?

Kind regards,

--
Ben Caradoc-Davies <Ben.Caradoc-Davies@anonymised.com>
Software Engineer, CSIRO Exploration and Mining
Australian Resources Research Centre
26 Dick Perry Ave, Kensington WA 6151, Australia

Ben Caradoc-Davies wrote:

Where should we put end-user documentation for app-schema applications of GeoServer? We have bits and pieces on the seegrid twiki, but this should me migrated either the GeoServer or GeoTools wikis.

app-schema configuration consists largely of creating a data directory, the most tricky part of which is the app-schema mapping file. Because the app-schema mapping file is the configuration file for GeoTools AppSchemaDataAccess, should it be documented in the GeoTools User Guide? This appears to be more aimed at library users, not GeoServer users.

If we do put it in the GeoServer manual, where does it go? I found the 1.7.x manual. Where is the trunk/development manual? Is there a 2.0.x version?

We have not really started the trunk manual yet. Once we get a bit closer to release the plan is to port the 1.7.x manual to trunk, and update it accordingly.

So... a couple of options for you Ben. Feel free to use confluence, and we can port to rST later when do we the manual port. Or, if you are comfortable with rST you can do it straight in rST/sphinx. We could create the skeleton for the trunk docs now, and you could add it directly. Your choice.

-Justin

Kind regards,

--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

Justin Deoliveira wrote:

We have not really started the trunk manual yet. Once we get a bit closer to release the plan is to port the 1.7.x manual to trunk, and update it accordingly.

So... a couple of options for you Ben. Feel free to use confluence, and we can port to rST later when do we the manual port. Or, if you are comfortable with rST you can do it straight in rST/sphinx. We could create the skeleton for the trunk docs now, and you could add it directly. Your choice.

Justin, I am working on an app-schema tutorial for 2.0_beta2 in
rst/sphinx. The trunk doc tree does not build, so I am developing on
1.7.x. What is the process for copying the docs? Surely these should
live on trunk like source? The trunk doc tree is empty.

Kind regards,

--
Ben Caradoc-Davies <Ben.Caradoc-Davies@anonymised.com>
Software Engineer, CSIRO Exploration and Mining
Australian Resources Research Centre
26 Dick Perry Ave, Kensington WA 6151, Australia

Hi Ben,

I sent email to the list about this:

http://www.mail-archive.com/geoserver-devel@lists.sourceforge.net/msg05473.html

-Justin

Ben Caradoc-Davies wrote:

Justin Deoliveira wrote:

We have not really started the trunk manual yet. Once we get a bit closer to release the plan is to port the 1.7.x manual to trunk, and update it accordingly.

So... a couple of options for you Ben. Feel free to use confluence, and we can port to rST later when do we the manual port. Or, if you are comfortable with rST you can do it straight in rST/sphinx. We could create the skeleton for the trunk docs now, and you could add it directly. Your choice.

Justin, I am working on an app-schema tutorial for 2.0_beta2 in
rst/sphinx. The trunk doc tree does not build, so I am developing on
1.7.x. What is the process for copying the docs? Surely these should
live on trunk like source? The trunk doc tree is empty.

Kind regards,

--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

Thanks Justin, I do recall your email, and will follow the instructions (create/copy and update index.rst as required).

Justin Deoliveira wrote:

Hi Ben,

I sent email to the list about this:

http://www.mail-archive.com/geoserver-devel@lists.sourceforge.net/msg05473.html

-Justin

Ben Caradoc-Davies wrote:

Justin Deoliveira wrote:

We have not really started the trunk manual yet. Once we get a bit closer to release the plan is to port the 1.7.x manual to trunk, and update it accordingly.

So... a couple of options for you Ben. Feel free to use confluence, and we can port to rST later when do we the manual port. Or, if you are comfortable with rST you can do it straight in rST/sphinx. We could create the skeleton for the trunk docs now, and you could add it directly. Your choice.

Justin, I am working on an app-schema tutorial for 2.0_beta2 in
rst/sphinx. The trunk doc tree does not build, so I am developing on
1.7.x. What is the process for copying the docs? Surely these should
live on trunk like source? The trunk doc tree is empty.

Kind regards,

--
Ben Caradoc-Davies <Ben.Caradoc-Davies@anonymised.com>
Software Engineer, CSIRO Exploration and Mining
Australian Resources Research Centre
26 Dick Perry Ave, Kensington WA 6151, Australia