Difference between revisions of "Live GIS Review"
Jump to navigation
Jump to search
| Line 15: | Line 15: | ||
: Documentation translation status, to be updated by translators. | : Documentation translation status, to be updated by translators. | ||
| − | = Overview Doc | + | = Application Review = |
| + | |||
| + | * Download the latest ISO or Virtual Machine from [ where? ] | ||
| + | For each application: | ||
| + | * Verify that you can select the application from the pull down menu. | ||
| + | * Run the application and verify the version installed is the same as described in the [https://spreadsheets.google.com/ccc?key=0Al9zh8DjmU_RdGIzd0VLLTBpQVJuNVlHMlBWSDhKLXc&hl=en_GB#gid=8 Status spreadsheet]. | ||
| + | * Once complete, update the "installed version" column in the [https://spreadsheets.google.com/ccc?key=0Al9zh8DjmU_RdGIzd0VLLTBpQVJuNVlHMlBWSDhKLXc&hl=en_GB#gid=8 Status spreadsheet]. | ||
| + | |||
| + | = Overview Doc Review = | ||
Reviewing can start once authors have completed a project's [[Live_GIS_Add_Project#Application_Overview|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] | Reviewing can start once authors have completed a project's [[Live_GIS_Add_Project#Application_Overview|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] | ||
| Line 23: | Line 31: | ||
** From [http://trac.osgeo.org/osgeo/browser/livedvd/gisvm/trunk/doc/en/overview svn directory], View updates by selecting | ** 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]" | "doc.rst"->"revision log"-> "[View Changes]" | ||
| − | * | + | * Ensure the new doc is referenced from the main [http://adhoc.osgeo.osuosl.org/livedvd/docs/en/overview/overview.html Contents page]. |
** Verify all images show up | ** 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] | ** Verify the version number matches the [https://spreadsheets.google.com/ccc?key=0Al9zh8DjmU_RdGIzd0VLLTBpQVJuNVlHMlBWSDhKLXc&hl=en_GB#gid=8 status spreadsheet] | ||
| Line 29: | Line 37: | ||
For completely new docs: | 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 | * 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 | ||
| + | * Ensure the doc is concise and clear to our target users. | ||
| + | : These users may be managers with limited technical expertise, so the documentation will need to provide content. Eg: The 52North Web Processing Services (WPS) needs to explain what a WPS is, and why it is useful before explaining the details of the 52nWPS implementation. | ||
| + | |||
| + | = Quickstart Review = | ||
| − | + | For each QuickStart: | |
| + | * Verify that it describes how to select the application from the desktop menu system. | ||
Revision as of 15:25, 1 February 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.
Application Review
- Download the latest ISO or Virtual Machine from [ where? ]
For each application:
- Verify that you can select the application from the pull down menu.
- Run the application and verify the version installed is the same as described in the Status spreadsheet.
- Once complete, update the "installed version" column in the Status spreadsheet.
Overview Doc Review
Reviewing can start once authors have completed a project's Overview and set "Overview status" = latest-version_draft, in the Status spreadsheet
Reviewers checklist:
- 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]"
- Ensure the new doc is referenced from the main Contents page.
- 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:
- 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
- Ensure the doc is concise and clear to our target users.
- These users may be managers with limited technical expertise, so the documentation will need to provide content. Eg: The 52North Web Processing Services (WPS) needs to explain what a WPS is, and why it is useful before explaining the details of the 52nWPS implementation.
Quickstart Review
For each QuickStart:
- Verify that it describes how to select the application from the desktop menu system.