Changes between Initial Version and Version 1 of spaceship_manual


Ignore:
Timestamp:
28 Dec 2017 11:50:57 (23 months ago)
Author:
bakaniko
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • spaceship_manual

    v1 v1  
     1__TOC__
     2
     3aka '''How to update a project in the documentation'''
     4
     5= Update project_info.csv =
     6
     7This is the main point of entry of the docs. This where you can change several things (described below):
     8
     9* document?
     10* page/project name (slug)
     11* version
     12* Quickstart?
     13* Overview?
     14* Classification
     15* last
     16* One Liner
     17* OpenHub name
     18* URL
     19* kind
     20* name
     21
     22== document? : ==
     23
     24Y if the project documentation should be build or not
     25
     26== page/project name (slug) ==
     27
     28Page name used to construct logo-<slug>.png <slug>_screenshot.png <slug>_overview.rst etc.
     29
     30Examples: - 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 - udig_overview.rst udig_quickstart.rst logo-udig.png udig-screensot.png
     31
     32Page name can contains dashes, underscore, numbers or capital letters but no spaces.
     33
     34== version ==
     35
     36Version of the project
     37
     38== Quickstart? ==
     39
     40Is there a quickstart ?
     41
     42== Overview? ==
     43
     44Is there an overview ?
     45
     46== Classification ==
     47
     48Desktop GIS | Browser Facing GIS | Web Services | Data Stores | Navigation and Maps | Spatial Tools | Domain Specific GIS | Data | Geospatial Libraries
     49
     50== last ==
     51
     52Used only for deprecated / removed projects and has the last version of OSGeoLive where it was available
     53
     54== One Liner ==
     55
     56One line description that goes after the quickstart link in the Overview page
     57
     58== OpenHub name ==
     59
     60Are your project registered onto OpenHub ? Please provide your name here
     61
     62== URL ==
     63
     64URL of the project
     65
     66== kind ==
     67
     68How 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.
     69
     70Parameters: * OSGeo_community * OSGeo_project * OSGeo_incubation * blank
     71
     72== name ==
     73
     74Name of the project (unlike slug).
     75
     76For example pgRouting (slug is {{{pgrouting}}})
     77
     78== files structure ==
     79
     80= Update project logo =
     81
     82Project screenshots are stock in the images folder following this path: {{{images/projects/<slug>/logo_<slug>.png}}}
     83
     84So if you want to change your project screenshot, just change the file there and that's it.
     85
     86= Update project screenshot =
     87
     88Like logos, project screenshots are stock in the images folder following this path:
     89
     90{{{images/projects/<slug>/<slug>_screenshot.png}}}
     91
     92So if you want to change your project screenshot, just change the file there and that's it.