Live GIS Add Project - Revision history

Wiki-Camerons: change svn references to git

2017-06-24T21:27:44Z

change svn references to git

Darkblueb: /* Packaging conventions */

2017-06-20T04:55:24Z

Packaging conventions

Darkblueb: /* Packaging conventions */

2017-06-20T04:52:38Z

Packaging conventions

Wiki-Epifanio: /* Notebooks */

2016-03-15T09:28:08Z

Notebooks

Wiki-Epifanio: /* Notebooks */

2016-03-15T09:25:37Z

Notebooks

Wiki-Epifanio at 09:22, 15 March 2016

2016-03-15T09:22:06Z

Wiki-Epifanio at 09:21, 15 March 2016

2016-03-15T09:21:33Z

Wiki-Epifanio: /* Notebook-Guidelines */

2016-03-15T09:01:57Z

Notebook-Guidelines

Wiki-Epifanio: /* Notebook-Guidelines */

2016-03-15T08:59:18Z

Notebook-Guidelines

Wiki-Epifanio: /* Notebooks */

2016-03-15T08:58:03Z

Notebooks

@@ Line 31: / Line 31: @@
 All install scripts for building the LiveGIS disc shall be licensed as LGPL.
-Scripts are stored here: https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/bin/
+Scripts are stored here: https://github.com/OSGeo/OSGeoLive/tree/master/bin
 Ideally, your application will already be packaged as a .deb file, probably in UbuntuGIS. Then the main part of the script uses apt-get, such as
-[https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/bin/install_mapserver.sh install_mapserver.sh], which is primarily
+[https://github.com/OSGeo/OSGeoLive/blob/master/bin/install_mapserver.sh install_mapserver.sh], which is primarily
   apt-get install mapserver
 Projects that haven't been packaged for Ubuntu yet are slightly more complicated:
-The uDig package is a good example: [https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/bin/install_udig.sh install_udig.sh]
+The uDig package is a good example: [https://github.com/OSGeo/OSGeoLive/blob/master/bin/install_udig.sh install_udig.sh]
-* 3rd Party Repositories: Create an <app>.list file with your repository in sources.list.d/ in the svn, in your script copy the file to the local machine like
+* 3rd Party Repositories: Create an <app>.list file with your repository in sources.list.d/ in the git, in your script copy the file to the local machine like
   cp -f ../sources.list/ubuntugis.list /etc/apt/sources.list.d/
@@ Line 47: / Line 47: @@
   apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 68436DDF
-The script should create an icon for desktop and menu. See section under: #### install desktop icon #### in [https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/bin/install_qgis.sh install_qgis.sh].
+The script should create an icon for desktop and menu. See section under: #### install desktop icon #### in [https://github.com/OSGeo/OSGeoLive/blob/master/bin/install_qgis.sh install_qgis.sh].
 When finished, ask the OSGeoLive team to reference your script from ''main.sh'', and add your icon from ''install_icons_and_menus.sh''
@@ Line 66: / Line 66: @@
 * '''/tmp''': Copy all downloads into /tmp/build_<package>/
-: Don't delete the /tmp/build_<package> directory afterwards. If the script is re-run, then time and bandwidth is saved by not having to download large files again. Do not do code checkouts or place temporary files in the starting build directory, which is ./bin/ in the live disc's SVN tree. See the "BUILD_DIR" environment variable used in a number of scripts if you later have to refer back to the ../app-conf/ or ../app-data/ relative paths in the live disc's SVN tree.
+: Don't delete the /tmp/build_<package> directory afterwards. If the script is re-run, then time and bandwidth is saved by not having to download large files again. Do not do code checkouts or place temporary files in the starting build directory, which is ./bin/ in the live disc's git tree. See the "BUILD_DIR" environment variable used in a number of scripts if you later have to refer back to the ../app-conf/ or ../app-data/ relative paths in the live disc's git tree.
 * '''Icons''': Where appropriate, create an icon on the desktop which loads the application. The file should be called <packagename>.desktop and placed in /home/user/Desktop/ for further processing. The icons will be sorted and the Geospatial menu will be auto-generated from here.
@@ Line 181: / Line 181: @@
 == Example Datasets ==
-In order to reduce disk space, and to provide consistency between projects, we strongly encourage all projects to make use of the common datasets packaged on OSGeo-Live by the [https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/bin/install_gisdata.sh install_gisdata.sh] script.
+In order to reduce disk space, and to provide consistency between projects, we strongly encourage all projects to make use of the common datasets packaged on OSGeo-Live by the [https://github.com/OSGeo/OSGeoLive/blob/master/bin/load_gisdata.sh load_gisdata.sh] script.
 All datasets should be installed into /usr/local/share/data, or if installed elsewhere, there should be a symbolic link into /usr/local/share/data. Data should not be installed in the /home/user directory, as I understand that data in the HOME directory is copied into RAM. (TBD find confirmation of this).
@@ Line 228: / Line 228: @@
 The [[Marketing_Artefacts#Application_Overview|Application Overview]] is a one page marketing page targeted at a someone considering using GeoSpatial Open Source, who may be a GeoSpatial User, a Technical person without much geospatial expertise, or manager with limited GeoSpatial or technical experience. Published Overviews are linked from here: http://live.osgeo.org/en/overview/overview.html
-The source Overviews are written in [http://sphinx.pocoo.org/rest.html RST wiki format] and built using sphinx. Source documents are to be stored here: https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/overview/en/<application>_overview.rst . They should follow the structure and style of the reference Overview, which has lots of helpful comments, at https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/en/overview/postgis_overview.rst
+The source Overviews are written in [http://sphinx.pocoo.org/rest.html RST wiki format] and built using sphinx. Source documents are to be stored here: https://github.com/OSGeo/OSGeoLive-doc/tree/master/en/overview/<application>_overview.rst . They should follow the structure and style of the reference Overview, which has lots of helpful comments, at https://github.com/OSGeo/OSGeoLive-doc/blob/master/en/overview/postgis_overview.rst
 The Overviews are currently published as [http://live.osgeo.org/overview/overview.html HTML pages]. In future we intend to also create 1 page PDFs, (to hand out as a flier at conferences, and as a page in the OSGeo Book of projects), and as Word/OpenOffice (to be cut and pasted into project proposals and articles which usually use these formats).
@@ Line 245: / Line 245: @@
 Try to make use of a friendly, conversational writing style, similar to the way a tutor would talk a class through an example. The quickstarts for [http://live.osgeo.org/en/quickstart/R_quickstart.html R] and [http://live.osgeo.org/en/quickstart/geoserver_quickstart.html GeoServer] do this very well.
-Source documentation is written in [http://sphinx.pocoo.org/rest.html RST wiki format], is built using sphinx, and is stored here: https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/en/quickstart/<application>_quickstart.rst
+Source documentation is written in [http://sphinx.pocoo.org/rest.html RST wiki format], is built using sphinx, and is stored here: https://github.com/OSGeo/OSGeoLive-doc/tree/master/en/quickstart/<application>_quickstart.rst
 The reference quickstart, which includes structure guidelines and with tips on how to fill in the quickstart is here:
-https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/en/quickstart/udig_quickstart.rst
+https://github.com/OSGeo/OSGeoLive-doc/blob/master/en/quickstart/udig_quickstart.rst
 In order to reduce disk space, and maintain consistency between applications, we request that all examples make use of the common [[#Example_Datasets]]. If the datasets don't cover your requirements, discuss this with us and we may add another suitable common dataset.
@@ Line 255: / Line 254: @@
 Applications are expected to include screen shots for each major step in the quickstart, as per [[#Screen_Shot|Screen Shot]].
-Once finished, note your project's quickstart status="draft" in the OSGeo-Live project status at: http://spreadsheets.google.com/ccc?key=0Al9zh8DjmU_RdGIzd0VLLTBpQVJuNVlHMlBWSDhKLXc&hl=en_GB#gid=5 and email live-demo@lists.osgeo.org noting your documentation is ready for review. Once reviewed, the status is moved to "complete" and is ready for translation.
+Once finished, email live-demo@lists.osgeo.org noting your documentation is ready for review.
 ==== Quickstart Review Checklist ====
@@ Line 296: / Line 295: @@
 ;Header logo:
-:* Stored here: https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/images/project_logos
+:* Stored here: https://github.com/OSGeo/OSGeoLive-doc/tree/master/images/project_logos
 :* Filename should be "logo-<projectname>.png" (apparently PNG is required for PDF docs)
 :* Should have a transparent background (not white)
@@ Line 313: / Line 312: @@
 * Screen shots can be taken using [http://shutter-project.org/ Shutter] (on linux) or [http://getgreenshot.org/ Greenshot] (on windows).
 * Screen shots should be taken from a 1024x768 display, and should be created in PNG format. (Apparently PNG is required for PDF documentation.)
-* Images are to be stored here: https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/images/screenshots/1024x768
+* Images are to be stored here: https://github.com/OSGeo/OSGeoLive-doc/tree/master/images/screenshots/1024x768
 * For Quickstarts, consider marking up the image to explain the current steps. Eg: Add circled numbers: 1, 2, 3 or draw an oval around buttons being described. This is very easy to do using the "Edit" tab in the Shutter program, which provides these drawing icons to add. Tutorials augmented with detailed and pertinent images make it easy for the reader to follow what is going on. Extra time spent on an image pays off big in comprehension (you need more than just a course screen dump). Lines, numbering, highlights, boxes and annotations all help direct a user's focus to those areas which are important.
 * Screenshots with large areas of constant color (menus, etc.) should be in PNG format, screenshots containing large areas of imagery (satellite images, shaded relief DEMs, etc.) should be in JPEG format.

@@ Line 84: / Line 84: @@
   mkdir -p <dir>
-* '''Binary files''': Do not put large (>5mb) binary files into the SVN repository without asking first. Due to SVN's preservation of history, once they are added they can never be removed, and forever-more clog up the backend database. Subversion is designed to be a ''source code management'' tool, not a data warehouse. There is space for large static data files (e.g. sample data) at http://download.osgeo.org/livedvd/data/. Just ask on the mailing list if you'd like to house something there.
+* '''Binary files''': Do not put large (>5mb) binary files into the source repository. Due to a preservation of history, once binary files are added they can never be removed, and forever-more clog up the backend database. A ''source code management'' tool is not a data warehouse. There is some space for (>5mb) static data files (e.g. sample data) at http://download.osgeo.org/livedvd/data/. Just ask on the mailing list if you'd like to house something there.
 = Packaging considerations =

@@ Line 54: / Line 54: @@
 * '''sudo''': Assume the script is to be executed as root. This means that sudo is only needed if you need to execute a command as e.g. the database user.
-: This means that ~/ refers to the directory /home/root/, so you should use ~user/ to reference /home/user/.
+: This means that ~/ refers to the directory /home/root/, so you should use /home/user/ explicitly or its equivalent.
 : Preferred method is to put the <tt>USER_NAME</tt> and <tt>USER_HOME</tt> variables at the top, so these can be easily changed in all scripts if needed.
   USER_NAME="user"

← Older revision		Revision as of 09:28, 15 March 2016
Line 345:		Line 345:

	OSGeo-Live provides a set of digital notebooks to explore several open source solution for geospatial data analysis, with the aim of bridging together the several software libraries already installed on the OSGeo-live to perform complex geo-data-science workflows. The notebooks are developed in the [http://jupyter.org/ Jupyter] environments which is heavily based on the [http://ipython.org/notebook.html IPython notebook] project, are written id different languages (bash, python, R) and are organized in a series of "topic-oriented" geospatial notebooks.		OSGeo-Live provides a set of digital notebooks to explore several open source solution for geospatial data analysis, with the aim of bridging together the several software libraries already installed on the OSGeo-live to perform complex geo-data-science workflows. The notebooks are developed in the [http://jupyter.org/ Jupyter] environments which is heavily based on the [http://ipython.org/notebook.html IPython notebook] project, are written id different languages (bash, python, R) and are organized in a series of "topic-oriented" geospatial notebooks.
		+
		+	Astatic HTML rendering of the notebooks shipped within the OSGeo-Live is available at: [http://nbviewer.jupyter.org/github/OSGeo/OSGeoLive-Notebooks/blob/master/index.ipynb OSGeoLive-Notebooks]

	== Notebook-Guidelines ==		== Notebook-Guidelines ==

@@ Line 344: / Line 344: @@
 = Notebooks =
-Starting with OSGeo-Live 9.0 a set of digital notebooks to explore several open source solution for geospatial data analysis, with the aim of bridging together the several software libraries already installed on the OSGeo-live to perform complex geo-data-science workflows. The notebooks are developed in the Jupyter notebook server environments which is heavily based on the IPython project, are written id different languages (bash, python, R) and are organized in a series of "topic-oriented" geospatial notebooks.
+OSGeo-Live provides a set of digital notebooks to explore several open source solution for geospatial data analysis, with the aim of bridging together the several software libraries already installed on the OSGeo-live to perform complex geo-data-science workflows. The notebooks are developed in the [http://jupyter.org/ Jupyter] environments which is heavily based on the [http://ipython.org/notebook.html IPython notebook] project, are written id different languages (bash, python, R) and are organized in a series of "topic-oriented" geospatial notebooks.
 == Notebook-Guidelines ==

@@ Line 342: / Line 342: @@
 For details on how to translate, refer to [[Live GIS Translate]]
-== Notebooks ==
+= Notebooks =
 Starting with OSGeo-Live 9.0 a set of digital notebooks to explore several open source solution for geospatial data analysis, with the aim of bridging together the several software libraries already installed on the OSGeo-live to perform complex geo-data-science workflows. The notebooks are developed in the Jupyter notebook server environments which is heavily based on the IPython project, are written id different languages (bash, python, R) and are organized in a series of "topic-oriented" geospatial notebooks.
-=== Notebook-Guidelines ===
+== Notebook-Guidelines ==
 The intended use of the notebooks on the OSGeo-live is to include rich descriptive narrative to a data processing workflow, including the possibilities to interact with data through a nicely done interactive widget  system  and finally enabling the printing of publication-ready reports (see latex inline rendering and pdf export).

@@ Line 324: / Line 324: @@
 This should typically be achieved by creating a symbolic link from /var/www/<application> to /usr/local/share/doc/<application>
 == Notebooks ==
@@ Line 342: / Line 359: @@
 * avoid the use of network resources to allow offline use (alert the user otherwise)
 * when applicable use hyperlinks to the official project documentation (i.e.: if use a GRASS GIS command, the notebook developer is invited to ad add reference to the official documentation available on the OSGeo-Live)
 [[Category: Live-demo]]

@@ Line 333: / Line 333: @@
 The intended use of the notebooks on the OSGeo-live is to include rich descriptive narrative to a data processing workflow, including the possibilities to interact with data through a nicely done interactive widget  system  and finally enabling the printing of publication-ready reports (see latex inline rendering and pdf export).
-On the OSGeo-live, we are aiming to use the same `common dataset` among projects this way different software projects can be more easily compared,  say for their usage complexity or for output quality/performance comparison.
+On the OSGeo-live, we are aiming to use the same  [[Live_GIS_Add_Project#Example_Datasets|Example_Datasets]] among projects this way different software projects can be more easily compared,  say for their usage complexity or for output quality/performance comparison.
 Notebooks shipped within the OSGeo-live must:

← Older revision		Revision as of 08:58, 15 March 2016
Line 326:		Line 326:

	== Notebooks ==		== Notebooks ==
		+
		+	Starting with OSGeo-Live 9.0 a set of digital notebooks to explore several open source solution for geospatial data analysis, with the aim of bridging together the several software libraries already installed on the OSGeo-live to perform complex geo-data-science workflows. The notebooks are developed in the Jupyter notebook server environments which is heavily based on the IPython project, are written id different languages (bash, python, R) and are organized in a series of "topic-oriented" geospatial notebooks.
		+
		+	== Notebook-Guidelines ==
		+
		+	The intended use of the notebooks on the OSGeo-live is to include rich descriptive narrative to a data processing workflow, including the possibilities to interact with data through a nicely done interactive widget system and finally enabling the printing of publication-ready reports (see latex inline rendering and pdf export).
		+
		+	On the OSGeo-live, we are aiming to use the same `common dataset` among projects this way different software projects can be more easily compared, say for their usage complexity or for output quality/performance comparison.
		+
		+	Notebooks shipped within the OSGeo-live must:
		+
		+	* be the result of original work specifically designed to run on the OSGeo-live
		+	* describe a workflow related to geospatial data analysis where code and software documentation are merged together by a rich descriptive narrative.
		+	* use dataset already present on the OSGeo-live dis (Notebooks developer are free to generate novel data i.e.: from querying available database or using using numerical tools to generate synthetic dataset)
		+	* avoid the use of network resources to allow offline use (alert the user otherwise)
		+	* when applicable use hyperlinks to the official project documentation (i.e.: if use a GRASS GIS command, the notebook developer is invited to ad add reference to the official documentation available on the OSGeo-Live)

	== Publishing Documentation ==		== Publishing Documentation ==