Opened 15 years ago
Closed 14 years ago
#430 closed task (fixed)
Create documentation for the LiveDVD
| Reported by: | camerons | Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | |
| Component: | OSGeoLive | Keywords: | documentation |
| Cc: |
Description
User level documentation needs to be added for each application.
I'm looking for direction as to what this documentation should look like, and how it should be written.
At the moment, I think it should be available via a HTML page.
To start with, I've copied the documentation from the 2008 Live DVD into https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/ arramagong.css banner.bmp index.html jquery.js
Docs are updated using https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/bin/install_main_docs.sh
Change History (5)
comment:1 by , 15 years ago
follow-up: 3 comment:2 by , 15 years ago
The release VERSION number should be included in the documentation. It is stored in: https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/VERSION.txt
Changes should be referenced from the LiveDVD docs, and possibly should be copied onto the DVD too. https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/CHANGES.txt
We should have an "About Arramagong GISVM" item from the pull down menu, which references the version number. (In the same way as there is an "About Xubuntu")
comment:3 by , 15 years ago
Replying to camerons:
Changes should be referenced from the LiveDVD docs, and possibly should be copied onto the DVD too.
setup.sh installs a package called subversion-tools. This includes a little program called svn2cl. You point svn2cl at your Subversion repository (ie .../gisvm/trunk/) and it creates a ChangeLog file detailing each checkin. yay automation.
https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/CHANGES.txt
(d.n.e.)
Hamish
comment:4 by , 15 years ago
| Keywords: | documentation added |
|---|
fyi Markus found this link, looks interesting:
http://johnmacfarlane.net/pandoc/ http://johnmacfarlane.net/pandoc/demos.html ... http://trac.osgeo.org/grass/ticket/151#comment:11
and since it isn't listed in this ticket yet here's the nice Mediawiki -> PDF converter: http://en.wikipedia.org/wiki/Help:Books
Hamish
comment:5 by , 14 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
On the sample scripts (I remember udig at least) every project downloads its documentation to the recommended folder (/usr/share/_project_), so I assume this should be replaced by moving the docs download to this new script.