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


Ignore:
Timestamp:
12 Apr 2018 13:08:25 (13 months ago)
Author:
bakaniko
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • How to document the quickstart file

    v2 v3  
    55== Where to find the quickstart files
    66
    7 The overview files are located at:
     7The quickstart files are located at:
    88
    99https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/quickstart
     
    1515*  Words surrounded by `< >` are to be defined by the person documenting the project
    1616  * `<slug>` is the slug name defined on `projects_info.csv` file
    17 * The project overview file name is `<slug>_quickstart.rst` for example `udig_quickstart.rst`
     17* The project quickstartfile name is `<slug>_quickstart.rst` for example `udig_quickstart.rst`
    1818* Words surrounded by `@ @` are variables
    1919* Words surrounded by `| |` are Sphinx variables
    2020
     21Most 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 ]
    2122
     23It 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
    2224
    2325||= Variable =||= Example =||= Action =||
    2426|| @LOGO_<slug>@ || `@LOGO_udig@` || Gets the logo image of the project  if it exists ||
    25 || @OSGEO_KIND_<slug>@ || `@OSGEO_KIND_udig@` || Gets the logo of the kind of project within OSGeo as defined on the `projects_info.csv`||
    26 || @NAME_<slug>@ || `@NAME_udig@` || Gets the name of the project as defined on the `projects_info.csv` ||
    27 || @QUICKSTART_<slug>@ || `@QUICKSTART_udig@` || Will generate a link to the quickstart if defined on the `projects_info.csv`  ||
     27|| @OSGEO_KIND_<slug>@ || `@OSGEO_KIND_udig@` || Gets the logo of the kind of project within OSGeo as defined into `projects_info.csv`||
     28|| @NAME_<slug>@ || `@NAME_udig@` || Gets the name of the project as defined into `projects_info.csv` ||
     29|| @QUICKSTART_<slug>@ || `@QUICKSTART_udig@` || Will generate a link to the quickstart if defined into `projects_info.csv`  ||
    2830|| @SCREENSHOT_<slug>@ || `@SCREENSHOT_udig@` || Places the screenshot to a given standard size ||
    29 || |version-<slug>| || `|version-udig|` || Project's version defined on the `projects_info.csv`
     31|| |version-<slug>| || `|version-udig|` || Project's version defined into `projects_info.csv`
    3032
    3133
     
    7678A subtitle has a line with 80 '-', and you  use them to separate sections within the title
    7779
    78 The following is an image, and Its being described here
     80The following is an image, and it is being described here
    7981
    8082.. image:: /images/projects/<slug>/image_name.png
     
    123125::
    124126
    125    Code starts here, (note the blank line bewtween the `::` and the code
     127   Code starts here, (note the blank line between the `::` and the code
    126128   More code
    127129