Changes between Version 2 and Version 3 of How to document the quickstart file

Timestamp:

04/12/18 13:08:25 (7 years ago)

Author:

bakaniko

Comment:

--

How to document the quickstart file

@@ -5 +5 @@
 == Where to find the quickstart files
 
-The overview files are located at:
+The quickstart files are located at:
 
 https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/quickstart
@@ -15 +15 @@
 *  Words surrounded by `< >` are to be defined by the person documenting the project
   * `<slug>` is the slug name defined on `projects_info.csv` file
-* The project overview file name is `<slug>_quickstart.rst` for example `udig_quickstart.rst`
+* The project quickstartfile name is `<slug>_quickstart.rst` for example `udig_quickstart.rst`
 * Words surrounded by `@ @` are variables
 * Words surrounded by `| |` are Sphinx variables
 
+Most of those variable points to data collected into a file called `projects_info.csv` that you can find at the root of the documentation folder: [https://github.com/OSGeo/OSGeoLive-doc/blob/b1d9cce02535fd75e9b891ebaea379103ab831bb/projects_info.csv ]
 
+It can be a good idea to fill this file first before writing the quickstart page. How to fill `projects_info.csv` is explained here : https://trac.osgeo.org/osgeolive/wiki/How%20to%20configure%20a%20project%20documentation
 
 ||= Variable =||= Example =||= Action =||
 || @LOGO_<slug>@ || `@LOGO_udig@` || Gets the logo image of the project  if it exists ||
-|| @OSGEO_KIND_<slug>@ || `@OSGEO_KIND_udig@` || Gets the logo of the kind of project within OSGeo as defined on the `projects_info.csv`||
-|| @NAME_<slug>@ || `@NAME_udig@` || Gets the name of the project as defined on the `projects_info.csv` ||
-|| @QUICKSTART_<slug>@ || `@QUICKSTART_udig@` || Will generate a link to the quickstart if defined on the `projects_info.csv`  ||
+|| @OSGEO_KIND_<slug>@ || `@OSGEO_KIND_udig@` || Gets the logo of the kind of project within OSGeo as defined into  `projects_info.csv`||
+|| @NAME_<slug>@ || `@NAME_udig@` || Gets the name of the project as defined into `projects_info.csv` ||
+|| @QUICKSTART_<slug>@ || `@QUICKSTART_udig@` || Will generate a link to the quickstart if defined into `projects_info.csv`  ||
 || @SCREENSHOT_<slug>@ || `@SCREENSHOT_udig@` || Places the screenshot to a given standard size ||
-|| |version-<slug>| || `|version-udig|` || Project's version defined on the `projects_info.csv`
+|| |version-<slug>| || `|version-udig|` || Project's version defined into `projects_info.csv`
 
 
@@ -76 +78 @@
 A subtitle has a line with 80 '-', and you  use them to separate sections within the title
 
-The following is an image, and Its being described here
+The following is an image, and it is being described here
 
 .. image:: /images/projects/<slug>/image_name.png
@@ -123 +125 @@
 ::
 
-   Code starts here, (note the blank line bewtween the `::` and the code
+   Code starts here, (note the blank line between the `::` and the code
    More code