[GeoNetwork-devel] GeoNetwork docs not on the OSGeo Live DVD?

GeoNetwork GeoNetwork Developer
1

GeoNetwork-devel,
It seems Jeroen is on holidays. Would someone else be able to update the GeoNetwork docs on the LiveDVD while he is away, as per the detailed steps below.

··· 
-- 
Cameron Shorter
Geospatial Director
Tel: +61 (0)2 8570 5050
Mob: +61 (0)419 142 254

Think Globally, Fix Locally
Geospatial Solutions enhanced with Open Standards and Open Source
[http://www.lisasoft.com](http://www.lisasoft.com)
2

Hi Cameron, maybe a bit too late a proposal page for the GeoNetwork overview page.

Cheers.
Francois

2010/7/24 Cameron Shorter <cameron.shorter@anonymised.com>

GeoNetwork-devel,
It seems Jeroen is on holidays. Would someone else be able to update the GeoNetwork docs on the LiveDVD while he is away, as per the detailed steps below.

-------- Original Message --------

Subject:

GeoNetwork docs not on the OSGeo Live DVD?

Date:

Sun, 25 Jul 2010 07:35:07 +1000

From:

Cameron Shorter <cameron.shorter@anonymised.com>

To:

Jeroen Ticheler <Jeroen.Ticheler@anonymised.com>

Hi Jeroen,
I notice that the GeoNetwork overview docs have not been converted to RST format yet. Have you run into any technical glitches which we can help you with?
Can you please look into this ASAP as we want to be able to review and provide feedback before the DVD is burned.

The generated Application docs look fantastic now, description on how to update them is here:
http://wiki.osgeo.org/wiki/Live_GIS_Add_Project#Application_Overview

If you have time, we’d love to have Quick Start documentation created too. (This is highly desirable, but not mandatory)
http://wiki.osgeo.org/wiki/Live_GIS_Add_Project#Application_Quick_Start

http://wiki.osgeo.org/wiki/Live_GIS_Add_Project#Application_Overview

Application Overview

The Application Overview is a one page marketing page written in RST wiki format and built using sphinx. It is to be stored here: https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/overview/_overview.rst

An example, with tips on how to fill in the overview is here: https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/overview/postgis_overview.rst You will also need:

(A 800x600 desktop image will be acceptable, but is not the preferred, as we plan to create additional higher quality PDF files from these images)

Screenshots with large areas of constant color (menus, etc.) should be in PNG format, screenshots containing large areas of imagery (satellite images, shaded relief DEMs, etc.) should be in JPEG format.
- A project logo, stored here: [https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/images/project_logos](https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/images/project_logos)

In many cases, text for the overview will be similar to existing Application Description documentation (which is being deprecated). https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/descriptions/_description.html

Once finished, you can verify your reST text looks good by building using the following:

(*you will have to have [Sphinx](http://sphinx.pocoo.org/) installed, it's in the* `python-sphinx` *Debian package*)
 sudo apt-get install python-sphinx


 cd osgeo/livedvd/gisvm/trunk/doc/overview
 make html

You can then view the results in:

osgeo/livedvd/gisvm/trunk/doc/_build/*.html

Try printing the html page from the browser, and ensure that the page is less than one page long. (The less words you write, the more people will read your documentation.)

Once finished, note your documentation is complete in the project status at: http://spreadsheets.google.com/ccc?key=0Al9zh8DjmU_RdGIzd0VLLTBpQVJuNVlHMlBWSDhKLXc&hl=en_GB#gid=5

On 16/07/10 06:54, Cameron Shorter wrote:

I’m now comfortable that the Application Overview template is ready to be populated. In many cases, much of the content will just be a refinement of existing Application Description documentation.

Instructions on how to fill it out are here:
http://wiki.osgeo.org/wiki/Live_GIS_Add_Project#Application_Overview

There are also plenty of hints in the referenced example here:
https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/overview/postgis_overview.rst

We have a documentation freeze in 10 days, on 26 July.

I’m now moving onto finalising the Application QuickStart documentation template, which will be highly desirable for this release, but not mandatory.

-- 
Cameron Shorter
Geospatial Director
Tel: +61 (0)2 8570 5050
Mob: +61 (0)419 142 254

Think Globally, Fix Locally
Geospatial Solutions enhanced with Open Standards and Open Source
[http://www.lisasoft.com](http://www.lisasoft.com)

This SF.net email is sponsored by Sprint
What will you do first with EVO, the first 4G phone?
Visit sprint.com/first – http://p.sf.net/sfu/sprint-com-first

GeoNetwork-devel mailing list
GeoNetwork-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geonetwork-devel
GeoNetwork OpenSource is maintained at http://sourceforge.net/projects/geonetwork

(attachments)

geonetwork-overview.png
geonetwork_overview.rst (3.88 KB)

3

Thanks for sending those in, I've got them in our svn now and will get
someone to look them over.

Alex

On 07/27/2010 12:55 AM, Francois Prunayre wrote:

Hi Cameron, maybe a bit too late a proposal page for the GeoNetwork overview
page.

Cheers.
Francois

2010/7/24 Cameron Shorter <cameron.shorter@anonymised.com>

GeoNetwork-devel,
It seems Jeroen is on holidays. Would someone else be able to update the
GeoNetwork docs on the LiveDVD while he is away, as per the detailed steps
below.

-------- Original Message -------- Subject: GeoNetwork docs not on the
OSGeo Live DVD? Date: Sun, 25 Jul 2010 07:35:07 +1000 From: Cameron
Shorter <cameron.shorter@anonymised.com> <cameron.shorter@anonymised.com> To: Jeroen
Ticheler <Jeroen.Ticheler@anonymised.com> <Jeroen.Ticheler@anonymised.com>

Hi Jeroen,
I notice that the GeoNetwork overview docs have not been converted to RST
format yet. Have you run into any technical glitches which we can help you
with?
Can you please look into this ASAP as we want to be able to review and
provide feedback before the DVD is burned.

The generated Application docs look fantastic now, description on how to
update them is here:
http://wiki.osgeo.org/wiki/Live_GIS_Add_Project#Application_Overview

If you have time, we'd love to have Quick Start documentation created too.
(This is highly desirable, but not mandatory)
http://wiki.osgeo.org/wiki/Live_GIS_Add_Project#Application_Quick_Start

--------------
http://wiki.osgeo.org/wiki/Live_GIS_Add_Project#Application_Overview
Application Overview

The Application Overview<http://wiki.osgeo.org/wiki/Marketing_Artefacts#Application_Overview&gt;is a one page marketing page written in RST
wiki format <http://sphinx.pocoo.org/rest.html&gt; and built using sphinx. It
is to be stored here:
https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/overview/&lt;application&gt;\_overview\.rst

An example, with tips on how to fill in the overview is here:
https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/overview/postgis_overview.rstYou will also need:

   - an image for the application, usually a screen shot or collage of
   screen shots, taken from a 1024x768 display, and stored here:
   https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/images/screenshots/1024x768

(A 800x600 desktop image will be acceptable, but is not the preferred, as
we plan to create additional higher quality PDF files from these images)
Screenshots with large areas of constant color (menus, etc.) should be in
PNG format, screenshots containing large areas of imagery (satellite images,
shaded relief DEMs, etc.) should be in JPEG format.

   - A project logo, stored here:
   https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/images/project_logos

In many cases, text for the overview will be similar to existing
Application Description documentation (which is being deprecated).
https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/descriptions/&lt;application&gt;\_description\.html

Once finished, you can verify your reST<http://docutils.sourceforge.net/rst.html&gt;text looks good by building using the following:
(*you will have to have Sphinx <http://sphinx.pocoo.org/&gt; installed, it's
in the* python-sphinx *Debian package*)

sudo apt-get install python-sphinx

cd osgeo/livedvd/gisvm/trunk/doc/overview
make html

You can then view the results in:

osgeo/livedvd/gisvm/trunk/doc/_build/*.html

Try printing the html page from the browser, and ensure that the page is
less than one page long. (The less words you write, the more people will
read your documentation.)

Once finished, note your documentation is complete in the project status
at:
http://spreadsheets.google.com/ccc?key=0Al9zh8DjmU_RdGIzd0VLLTBpQVJuNVlHMlBWSDhKLXc&hl=en_GB#gid=5

On 16/07/10 06:54, Cameron Shorter wrote:

I'm now comfortable that the Application Overview template is ready to be
populated. In many cases, much of the content will just be a refinement of
existing Application Description documentation.

Instructions on how to fill it out are here:
http://wiki.osgeo.org/wiki/Live_GIS_Add_Project#Application_Overview

There are also plenty of hints in the referenced example here:

https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/overview/postgis_overview.rst

We have a documentation freeze in 10 days, on 26 July.

I'm now moving onto finalising the Application QuickStart documentation
template, which will be highly desirable for this release, but not
mandatory.

--
Cameron Shorter
Geospatial Director
Tel: +61 (0)2 8570 5050
Mob: +61 (0)419 142 254

Think Globally, Fix Locally
Geospatial Solutions enhanced with Open Standards and Open Sourcehttp://www.lisasoft.com