Changes between Version 16 and Version 17 of How to configure a project documentation
- Timestamp:
- 08/13/24 13:45:35 (8 weeks ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
How to configure a project documentation
v16 v17 10 10 [https://github.com/OSGeo/OSGeoLive-doc/blob/master/projects_info.csv] 11 11 12 To add a new project, you have to add a new line in this file. To update a project information s, just modify the corresponding line.12 To add a new project, you have to add a new line in this file. To update a project information, just modify the corresponding line. 13 13 Then commit and push your changes and make a pull request to the OSGeoLive repository. 14 14 … … 16 16 = project_info.csv organization 17 17 18 The file is organized with 13 columns/fields separated by the pipe `|` symbol: 18 The file is organized with 13 columns/fields 19 * separated by the pipe `|` symbol: 20 * Columns with `?` symbol requiere a `Y` or `N` Value 19 21 20 22 {{{ … … 35 37 * Data: Spatial data sets 36 38 * Geospatial Libraries 37 * RETIRED: projects that have been retired f or some reason but can be reactivated39 * RETIRED: projects that have been retired from the project 38 40 39 41 … … 67 69 Page name can contains dashes, underscore, numbers or capital letters but no spaces. 68 70 69 Examples: 70 71 - pgRouting is the real name of the project but the page name is {{{pgrouting}}} 72 73 74 - User-friendly Desktop Internet GIS is the real name of the project but udig is the page name 75 76 - it gives: `udig_overview.rst` `udig_quickstart.rst` `logo-udig.png` `udig-screensot.png` 71 - It determines what files needs to be created. 72 73 Example: 74 75 `User-friendly Desktop Internet GIS` is the real name of the project but `udig` is the slug 76 77 - The following files will be looked for: 78 - Under [https://github.com/OSGeo/OSGeoLive-doc/blob/master/doc/overview/ doc/overview/] the file [https://github.com/OSGeo/OSGeoLive-doc/blob/master/doc/overview/udig_overview.rst udig_overview.rst] will be looked for if 79 - `document?` has `Y` and Overview? has `Y` 80 - Under [https://github.com/OSGeo/OSGeoLive-doc/blob/master/doc/quickstart/ doc/quickstart/] the file [https://github.com/OSGeo/OSGeoLive-doc/blob/master/doc/quickstart/udig_quickstart.rst udig_quickstart.rst] will be looked for if 81 - `document?` has `Y` and Quickstart? has `Y` 82 - Under [https://github.com/OSGeo/OSGeoLive-doc/blob/master/doc/images/projects/udig doc/images/projects/udig] the image [https://github.com/OSGeo/OSGeoLive-doc/blob/master/doc/images/projects/udig/logo_udig.png logo-udig.png] will be used any time `@LOGO_udig@` appears in the documentation. (Normaly on the project overview) 83 - Under [https://github.com/OSGeo/OSGeoLive-doc/blob/master/doc/images/projects/udig doc/images/projects/udig] the image [https://github.com/OSGeo/OSGeoLive-doc/blob/master/doc/images/projects/udig/udig_screenshot.png udig-screensot.png] image will be used any time `@SCREENSHOT_geomajas@` appears in the documentation. (Normaly on the project overview) 77 84 78 85 79 86 == version 80 87 81 Version of the project 88 Version of the project that is included on OSGeoLive. 89 90 - A proposed value can be set up. 91 - The definitive value will be set by OSGeoLive developers. 82 92 83 93 Examples: … … 88 98 == Quickstart? 89 99 90 Is there a quickstart ? 91 Add {{{Y}}} if the documentation should build a quickstart page for this project, {{{N}}} if it doesn't. 100 Is there a quickstart? 101 102 Add {{{Y}}} if the documentation should build a quickstart page for the project, {{{N}}} if it doesn't. 92 103 93 104 == Overview? 94 105 95 Is there an overview ? 96 Add {{{Y}}} if the documentation should build an overviewpage for this project, {{{N}}} if it doesn't. 106 Is there an overview? 107 108 Add {{{Y}}} if the documentation should build an overview page for the project, {{{N}}} if it doesn't. 97 109 98 110 == Classification 99 General 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. 100 101 Desktop GIS | Browser Facing GIS | Web Services | Data Stores | Navigation and Maps | Spatial Tools | Domain Specific GIS | Data | Geospatial Libraries 111 112 General category where your project fit in. 113 114 Please choose in the ones provided below. 115 116 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. 117 118 For readability please also set the line in the corresponding section 119 120 * Desktop GIS : General GIS viewing, editing and analysis in the browser 121 * Browser Facing GIS: General GIS viewing, editing and analysis in the browser 122 * Web Services: Publishing spatial data to the internet 123 * Data Stores: Storing spatial data 124 * Navigation and Maps 125 * Spatial Tools: Specific analysis tools 126 * Domain Specific GIS: Applications targeted at a specific domain 127 * Data: Spatial data sets 128 * Geospatial Libraries 129 * RETIRED: projects that have been retired from the project 102 130 103 131 == last 104 132 105 Used only for deprecated / removed projects and has the last version of OSGeoLive where it was available 133 Used only for deprecated / removed projects and has the last version of OSGeoLive where it was available. 106 134 107 135 == One Liner … … 142 170 For example pgRouting (slug is {{{pgrouting}}}) 143 171 144 == ISO 172 == ISO? 145 173 146 174 Adds a mention if the project is in the VMDK only and not in the ISO. `reserved to OSGeoLive members` 147 Often it is a matter of size in the ISO. 148 149 Projects included in the ISO are included in the VMDK. 175 - Often it is a matter of size in the ISO. 176 - Projects included in the ISO are included in the VMDK. 150 177 151 178 It takes 2 values: … … 153 180 * `Y` : project included the ISO (default value) 154 181 * `N` : project included the VMDK only 155 {{{#!comment 156 = General file structure 182 157 183 158 184 == Overviews and quickstarts … … 197 223 198 224 199 For example, for QGIS, the project slug is: `qgis` so the logo is `doc/images/projects/qgis/qgis_screenshot.png` 200 201 }}} 225 For example, for QGIS, the project slug is: `qgis` so the logo is `doc/images/projects/qgis/qgis_screenshot.png