Difference between revisions of "Live GIS Review"

From OSGeo
Jump to navigation Jump to search
Line 1: Line 1:
This page describes our quality control processes for OSGeo-Live.
+
-- DRAFT: This page is still being developed --
  
 +
''This page describes our quality control processes for OSGeo-Live.''
 +
 +
= Background =
 
OSGeo-Live has built a reputation around maintaining a high level of quality for all included applications. To ensure we maintain this quality, we need to not only test to make sure everything works as expected, but also keep track of testing status can show a clean report card on what works, and also take action when something is not working as expected.
 
OSGeo-Live has built a reputation around maintaining a high level of quality for all included applications. To ensure we maintain this quality, we need to not only test to make sure everything works as expected, but also keep track of testing status can show a clean report card on what works, and also take action when something is not working as expected.
  
Below are the testing and verification processes to follow for each of our artifacts:
+
Below are the testing and verification processes to follow for each of our artefacts:
  
= Status Spreadsheet =
+
= Status Spreadsheets =
The status of installed applications and documentation is stored in a Google Docs [https://spreadsheets.google.com/ccc?key=0Al9zh8DjmU_RdGIzd0VLLTBpQVJuNVlHMlBWSDhKLXc&hl=en_GB#gid=8 OSGeo-Live status spreadsheet].
+
[https://spreadsheets.google.com/ccc?key=0Al9zh8DjmU_RdGIzd0VLLTBpQVJuNVlHMlBWSDhKLXc&hl=en_GB#gid=8 OSGeo-Live applications status]
 +
: Status of applications to be updated by packagers.
  
= Application Overview Docs =
+
; [https://spreadsheets.google.com/ccc?key=0AlRFyY1XenjJdFRDbjFyWHg1MlNTRm10QXk0UWEzWlE&hl=en_GB&authkey=CPTB6uIE#gid=5 Translations status]
Once authors have completed the [Live_GIS_Add_Project#Application_Overview] they should set "Overview status" = <span style="background:yellow">latest-version_draft</span>
+
: Documentation translation status, to be updated by translators.
 +
 
 +
= Overview Doc Checklist =
 +
Reviewing can start once authors have completed the [Live_GIS_Add_Project#Application_Overview] and set "Overview status" = <span style="background:yellow">latest-version_draft</span>, in the [https://spreadsheets.google.com/ccc?key=0Al9zh8DjmU_RdGIzd0VLLTBpQVJuNVlHMlBWSDhKLXc&hl=en_GB#gid=8 Status spreadsheet]
 
Reviewers should:
 
Reviewers should:
 
* Check the difference between this version and last to determine what has changed.
 
* Check the difference between this version and last to determine what has changed.
* ...
+
** Determine the version of "en" docs for last two osgeo releases (eg, between "en" and "4.0en") from the [https://spreadsheets.google.com/ccc?key=0AlRFyY1XenjJdFRDbjFyWHg1MlNTRm10QXk0UWEzWlE&hl=en_GB&authkey=CPTB6uIE#gid=5 Translation summary]
 +
** From [http://trac.osgeo.org/osgeo/browser/livedvd/gisvm/trunk/doc/en/overview svn directory], View updates by selecting "doc.rst"->"revision log"-> "[View Changes]"
 +
* View document which should be linked from the [http://adhoc.osgeo.osuosl.org/livedvd/docs/en/overview/overview.html Nightly build docs]
 +
** Verify all images show up
 +
** Verify the version number matches the  [https://spreadsheets.google.com/ccc?key=0Al9zh8DjmU_RdGIzd0VLLTBpQVJuNVlHMlBWSDhKLXc&hl=en_GB#gid=8 status spreadsheet]
 +
** Ensure all new text is grammatically and syntactically correct.
 +
 
 +
For completely new docs:
 +
* Ensure the doc follows overview outline, as per the example doc: https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/overview/en/postgis_overview.rst
  
 
= Application Quickstarts =
 
= Application Quickstarts =

Revision as of 03:15, 30 January 2011

-- DRAFT: This page is still being developed --

This page describes our quality control processes for OSGeo-Live.

Background

OSGeo-Live has built a reputation around maintaining a high level of quality for all included applications. To ensure we maintain this quality, we need to not only test to make sure everything works as expected, but also keep track of testing status can show a clean report card on what works, and also take action when something is not working as expected.

Below are the testing and verification processes to follow for each of our artefacts:

Status Spreadsheets

OSGeo-Live applications status
Status of applications to be updated by packagers.
Translations status
Documentation translation status, to be updated by translators.

Overview Doc Checklist

Reviewing can start once authors have completed the [Live_GIS_Add_Project#Application_Overview] and set "Overview status" = latest-version_draft, in the Status spreadsheet Reviewers should:

  • Check the difference between this version and last to determine what has changed.
    • Determine the version of "en" docs for last two osgeo releases (eg, between "en" and "4.0en") from the Translation summary
    • From svn directory, View updates by selecting "doc.rst"->"revision log"-> "[View Changes]"
  • View document which should be linked from the Nightly build docs
    • Verify all images show up
    • Verify the version number matches the status spreadsheet
    • Ensure all new text is grammatically and syntactically correct.

For completely new docs:

Application Quickstarts