Changes between Version 6 and Version 7 of How to document a project

Timestamp:

05/05/19 06:10:11 (6 years ago)

Author:

camerons

Comment:

Added project_info.csv

How to document a project

@@ -44 +44 @@
 * 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.
 * For PNGs run a program like [http://packages.ubuntu.com/pngcrush pngcrush] to reduce the size of the image without degrading quality.
+
+= project_info.csv =
+The [https://github.com/OSGeo/OSGeoLive-doc/blob/master/projects_info.csv project_info.csv] config table defines which projects are included in OSGeoLive docs during the doc build process. 
+
+Each project has a dedicated row with metadata and variables, with fields separated by the pipe `|` symbol.
+Rows starting with a hash `#` symbol are comment rows. Rows have been organised into categories, and new projects should be inserted into the correct category.
+
+Note: Documentation for a new project should only be enabled with oversight from the OSGeoLive Project Steering Committee.
+
+The purpose of fields is described below.
+
+{{{
+# document? | slug |version| Quickstart? |Overview?|Section| last | One Liner| OpenHub name |URL|kind|name
+}}}
+
+== document ==
+
+Add {{{Y}}} if the project documentation should be built.
+
+If the project has been retired, change to {{{N}}} and move the row to the retired section.
+
+== slug ==
+
+Page name used to construct `logo-<slug>.png` `<slug>_screenshot.png` `<slug>_overview.rst` etc.
+Page name can contains dashes, underscore, numbers or capital letters but no spaces.
+
+Examples: 
+
+* pgRouting is the real name of the project but the page name is {{{pgrouting}}} 
+* User-friendly Desktop Internet GIS is the real name of the project but udig is the page name 
+* it gives: `udig_overview.rst` `udig_quickstart.rst` `logo-udig.png` `udig-screensot.png`
+
+== version ==
+
+The project's software version.
+
+Examples:
+* `2.14.14` for QGIS 2.14.14
+* `4.3.0a` for 4.3.0 alpha release of Spatialite
+
+== Quickstart? ==
+
+Add {{{Y}}} if the documentation should build a quickstart page for this project, {{{N}}} if it shouldn't.
+
+== Overview? ==
+
+Add {{{Y}}} if the documentation should build an overview page for this project, {{{N}}} if it shouldn't.
+
+== Classification ==
+Select from one of the existing categories listed here. These categories are used for grouping projects in documentation and presentation.
+
+Desktop GIS | Browser Facing GIS | Web Services | Data Stores | Navigation and Maps | Spatial Tools | Domain Specific GIS | Data | Geospatial Libraries
+
+== last ==
+
+Used only for deprecated / removed projects and contains the last version of OSGeoLive when the project was installed on OSGeoLive.
+
+== One Liner ==
+
+One line description that goes after the quickstart link in the Overview page.
+
+== !OpenHub name ==
+
+[https://live.osgeo.org/en/metrics.html OSGeoLive's metrics page] presents [https://www.openhub.net/ OpenHub] metrics to help users assess the maturity of projects. 
+
+Provide the !OpenHub name.
+
+For example:
+This is the link to !OpenHub for pgRouting:
+https://www.openhub.net/p/pgrouting
+
+Then the ''!OpenHub name'' is **pgrouting**
+
+== URL ==
+
+Insert the URL of the project's homepage.
+
+== kind ==
+Your OSGeo project categorisation, as per https://www.osgeo.org/projects/ . If associated with OSGeo, the corresponding OSGeo icon will be added to your project pages under the project logo.
+
+Parameters: 
+* `OSGeo_community` 
+* `OSGeo_project`
+* `OSGeo_incubation` 
+* blank
+
+== name ==
+
+Complete name of the project respecting the case (unlike slug).
+
+For example pgRouting (slug is {{{pgrouting}}})
+