Changes between Initial Version and Version 1 of How to configure a project documentation


Ignore:
Timestamp:
10 Apr 2018 12:52:17 (13 months ago)
Author:
cvvergara
Comment:

adding the initial contents

Legend:

Unmodified
Added
Removed
Modified
  • How to configure a project documentation

    v1 v1  
     1= How to update / add a project in the documentation
     2
     3
     4Since documentation is built automatically, projects data are stored in `project_info.csv` file. It is the main point of entry of the docs.
     5
     6To add a new project, you have to add a new line in this file. To update a project informations, just modify the corresponding line.
     7Then commit and push your changes and make a pull request to the OSGeoLive repository.
     8[[PageOutline(1-2)]]
     9
     10= project_info.csv organization
     11
     12The file is organized with 12 columns/fields separated by the pipe `|` symbol:
     13
     14{{{
     15# document? | slug |version| Quickstart? |Overview?|Section| last | One Liner| OpenHub name |URL|kind|name
     16}}}
     17
     18The 12 fields are described below.
     19
     20Several categories have been made with comments to help organize the projects. Please add your project in the corresponding one:
     21
     22* Desktop GIS : General GIS viewing, editing and analysis in the browser
     23* Browser Facing GIS: General GIS viewing, editing and analysis in the browser
     24* Web Services: Publishing spatial data to the internet
     25* Data Stores: Storing spatial data
     26* Navigation and Maps
     27* Spatial Tools: Specific analysis tools
     28* Domain Specific GIS: Applications targeted at a specific domain
     29* Data: Spatial data sets
     30* Geospatial Libraries
     31* RETIRED: projects that have been retired for some reason but can be reactivated
     32
     33
     34= Fields description
     35
     36Each field have a purpose in the doc building and should be fill carefully.
     37
     38* document?
     39* page/project name (slug)
     40* version
     41* Quickstart?
     42* Overview?
     43* Classification
     44* last
     45* One Liner
     46* OpenHub name
     47* URL
     48* kind
     49* name
     50
     51== document?
     52
     53Add {{{Y}}} if the project documentation should be build or not `reserved to OSGeoLive members`
     54
     55If the project have been retired, please change it to {{{N}}} and move it to retired section.
     56
     57== page/project name (slug)
     58
     59Page name used to construct `logo-<slug>.png` `<slug>_screenshot.png` `<slug>_overview.rst` etc.
     60Page name can contains dashes, underscore, numbers or capital letters but no spaces.
     61
     62Examples:
     63
     64- pgRouting is the real name of the project but the page name is {{{pgrouting}}}
     65
     66
     67- User-friendly Desktop Internet GIS is the real name of the project but udig is the page name
     68
     69- it gives: `udig_overview.rst` `udig_quickstart.rst` `logo-udig.png` `udig-screensot.png`
     70
     71
     72== version
     73
     74Version of the project
     75
     76Examples:
     77- `2.14.14` for QGIS 2.14.14
     78- `4.3.0a` for 4.3.0 alpha release of Spatialite
     79
     80
     81== Quickstart?
     82
     83Is there a quickstart ?
     84Add {{{Y}}} if the documentation should build a quickstart page for this project, {{{N}}} if it doesn't.
     85
     86== Overview?
     87
     88Is there an overview ?
     89Add {{{Y}}} if the documentation should build an overviewpage for this project, {{{N}}} if it doesn't.
     90
     91== Classification
     92General category where your project fit in. Please choose in the ones provided below. If your project needs a special category, please contact the OSGeoLive team so we can add it in our building process. Otherwise, the pages won't be built.
     93
     94Desktop GIS | Browser Facing GIS | Web Services | Data Stores | Navigation and Maps | Spatial Tools | Domain Specific GIS | Data | Geospatial Libraries
     95
     96== last ==
     97
     98Used only for deprecated / removed projects and has the last version of OSGeoLive where it was available
     99
     100== One Liner
     101
     102One line description that goes after the quickstart link in the Overview page
     103
     104== OpenHub name
     105
     106Are your project registered onto OpenHub ? Please provide your name here
     107
     108== URL
     109
     110Please insert here the complete URL of your project
     111
     112== kind
     113
     114How are you related to OSGeo ? Are you community ? In incubation or an OSGeo project ? If yes, the corresponding logo will be added to your project pages under the project logo.
     115
     116Parameters:
     117* `OSGeo_community`
     118* `OSGeo_project`
     119* `OSGeo_incubation`
     120* blank
     121
     122== name
     123
     124Complete name of the project respecting the case (unlike slug).
     125
     126For example pgRouting (slug is {{{pgrouting}}})
     127
     128= files structure
     129
     130== Update project logo
     131
     132Project logos are stock in the images folder of the OSGeolive-doc folder following this path: {{{images/projects/<slug>/logo_<slug>.png}}}
     133
     134So if you want to change/update your project logo, just change the file there and that's it.
     135Be careful that the name of the logo file his the same as the slug, otherwise it won't be found during the doc building.
     136
     137== Update project screenshot
     138
     139Like logos, project screenshots for the overview page are stock in the images folder following this path:
     140
     141{{{images/projects/<slug>/<slug>_screenshot.png}}}
     142
     143So if you want to change your project screenshot, just change the file there and that's it.
     144Be careful that the name of the screenshot file his the same as the slug, otherwise it won't be found during the doc building.