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

Timestamp:

04/12/18 12:04:15 (7 years ago)

Author:

bakaniko

Comment:

--

How to configure a project documentation

@@ -143 +143 @@
 = files structure
 
-== Update project logo
+== Overviews and quickstarts
 
-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]
+Each project has to have an Overview and a Quickstart. You can find more information on the dedicated pages:
 
-So if you want to change/update your project logo, just change the file there and that's it.
-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.
+* [https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20overview%20file]
+* []
 
-== Update project screenshot
+== Images
+
+Images are stocked in a specific folder: https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/images/projects
+
+To 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.
+
+=== Update project logo
+
+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/projects] and are stocked in the project folder.
+
+So 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.
+
+
+=== Update project screenshot
 
 Like logos, project screenshots for the overview page are stock in the images folder following this path:
@@ -157 +170 @@
 
 
+For the automated process of building the doumentation, we need you to call your screenshot image like this: {{{<your-project-slug>_screenshot.png}}}.
+That way it will be find easily during the creation of the documentation.
 
-So if you want to change your project screenshot, just change the file there and that's it.
-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.