Changes between Version 7 and Version 8 of How to configure a project documentation


Ignore:
Timestamp:
12 Apr 2018 12:04:15 (13 months ago)
Author:
bakaniko
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • How to configure a project documentation

    v7 v8  
    143143= files structure
    144144
    145 == Update project logo
     145== Overviews and quickstarts
    146146
    147 Project logos are stock in the images folder of the OSGeolive-doc folder following this path: [https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/images/logos]
     147Each project has to have an Overview and a Quickstart. You can find more information on the dedicated pages:
    148148
    149 So if you want to change/update your project logo, just change the file there and that's it.
    150 Be careful that the name of the logo file his the same as the slug, otherwise it won't be found during the doc building.
     149* [https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20overview%20file]
     150* []
    151151
    152 == Update project screenshot
     152== Images
     153
     154Images are stocked in a specific folder: https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/images/projects
     155
     156To create a new project, create a new folder here with {{{slug}}} of your project. As the screenshot and the logo image will be use automatically  to build the overview page, be careful with their name.
     157
     158=== Update project logo
     159
     160Project logos are stock in the images folder of the OSGeolive-doc folder following this path: [https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/images/projects] and are stocked in the project folder.
     161
     162So if you want to change/update your project logo, just change the file there and that's it. Please call it {{{logo_<your-project-slug>.png}}} so the program can find it.
     163
     164
     165=== Update project screenshot
    153166
    154167Like logos, project screenshots for the overview page are stock in the images folder following this path:
     
    157170
    158171
     172For the automated process of building the doumentation, we need you to call your screenshot image like this: {{{<your-project-slug>_screenshot.png}}}.
     173That way it will be find easily during the creation of the documentation.
    159174
    160 So if you want to change your project screenshot, just change the file there and that's it.
    161 Be careful that the name of the screenshot file his the same as the slug, otherwise it won't be found during the doc building.