Skip to content

Commit

Permalink
clean up 'Other' section
Browse files Browse the repository at this point in the history
  • Loading branch information
landam committed Jul 10, 2017
1 parent 6dbdf02 commit 272a1c5
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 76 deletions.
5 changes: 3 additions & 2 deletions docs/datasets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Natural earth
=============

Database ``natural-earth.sqlite``. Available online at
https://github.com/gislab-npo/gisquick/tree/master/qgis/project/natural-earth.
https://github.com/gislab-npo/gisquick-sample-projects/tree/master/natural-earth.

.. rubric:: Data source

Expand Down Expand Up @@ -140,7 +140,8 @@ data and other information (urban landscape)
Prague
======

Database ``prague.sqlite``:
Database ``prague.sqlite``. Available online at
https://github.com/gislab-npo/gisquick-sample-projects/tree/master/prague.

.. rubric:: Data source

Expand Down
58 changes: 54 additions & 4 deletions docs/installation/vagrant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ host machine.
<http://gislab.readthedocs.io/en/latest/installation/configuration.html#installation-of-requirements>`__
for installing software requirements in GIS.lab documentation.

.. _vagrant-up:

To deploy virtual server called ``gisquick`` run:

.. code-block:: sh
Expand All @@ -46,9 +48,19 @@ To deploy virtual server called ``gisquick`` run:
that, with next installation of server it can be faster because
software packages will have not to be downloaded again.

After succesfull deployment, created virtual machine can be accessed
via ``ssh`` vagrant command (must be called also from source code root
:file:`gisquick` directory).
After succesfull deployment, new directories in source code tree are
created:

``dev``
development directory
``dev/cache``
directory for caching map tiles
``dev/publish``
directory for QGIS projects publishing

Created virtual machine can be accessed via ``ssh`` vagrant command
(must be called also from source code root :file:`gisquick`
directory).

.. code-block:: sh
:emphasize-lines: 1
Expand All @@ -67,6 +79,8 @@ via ``ssh`` vagrant command (must be called also from source code root
Last login: Wed Apr 13 08:49:28 2016 from X.X.X.X
.. _vagrant-dev-services:

Development services can be started using ``tmux-dev.sh`` command
called from server prompt.

Expand Down Expand Up @@ -121,10 +135,46 @@ Halted machine can be launched again by ``vagrant up`` command.
$ vagrant destroy -f
Running virtual machine can be updated by
Update environment
------------------
Go to source code tree and update Git repository
.. code-block:: sh
$ git pull
Then launch virtual machine by ``vagrant up`` and perform provision
.. code-block:: sh
$ vagrant provision
It is recommended to restart virtual machine
.. code-block:: sh
$ vagrant reload
before starting :ref:`development services <vagrant-dev-services>`.
.. note:: |note| When there are fundamental changes, it is better to
destroy virtual machine.
.. code-block:: sh
$ vagrant -f destroy
$ vagrant up
In this case ``vagrant provision`` command is not needed.
.. tip:: |tip| Quick update can be done with ``git pull`` command
followed by running ``gulp build-web`` on server.
.. code-block:: sh
$ git pull && vagrant up && vagrant ssh
$ /vagrant/utils/tmux-dev.sh
$ cd /vagrant/clients
$ gulp build-web
100 changes: 30 additions & 70 deletions docs/other.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,43 @@ Other
Technologies
------------

* QGIS Desktop and Mapserver
* OpenLayers 3
* AngularJS, Angular UI, Angular Material
* Onsen
* Cordova
* Django
* Python
* `QGIS Desktop <http://qgis.org/en/site/>`__ and `Mapserver
<http://docs.qgis.org/2.18/en/docs/user_manual/working_with_ogc/ogc_server_support.html>`__
* `OpenLayers 3 <https://openlayers.org/>`__
* `AngularJS <https://angularjs.org/>`__
* `Cordova <https://cordova.apache.org/>`__
* `Django <https://www.djangoproject.com/>`__
* `Python <https://www.python.org/>`__

.. _source-code-layout:

------------------
Source code layout
------------------

See Gisquick `GitHub repository <https://github.com/gislab-npo/gisquick>`__.

``clients``
web and mobile client interfaces
``docker``
Docker recepies, see :doc:`./installation/docker`
``provision``
development environment provisioning configuration with Vagrant/Ansible, see :doc:`./installation/vagrant`
``server``
Django server
``qgis``
QGIS plugin
``provision``
development environment provisioning configuration with Vagrant/Ansible
``dev``
development directory
``dev/django``
directory for Django development project created during provisioning
``dev/publish``
directory for QGIS projects publishing

``utils``
Utilities

See also related GitHub repositories:

Gisquick QGIS plugin
https://github.com/gislab-npo/gisquick-qgis-plugin, see :doc:`./installation/plugin`.
Gisquick QGIS sample projets
https://github.com/gislab-npo/gisquick-sample-projects,
see :doc:`./datasets` section.
Gisquick documentation
https://github.com/gislab-npo/gisquick-doc

------
Mobile
------
Expand All @@ -48,19 +56,7 @@ built on top of the same code base as web inteface with native user interface.
Packaging
---------

* Gisquick QGIS plugin

.. code:: sh
$ cd /vagrant/qgis/gislab_web \
&& \
make clean \
&& \
make compile \
&& \
make zip
* Gisquick
* Gisquick application

.. code:: sh
Expand Down Expand Up @@ -88,42 +84,6 @@ Packaging
License
-------

GNU General Public License version 2 or later.

.. _gisquick-upgrade:

========================
How to upgrade Gisquick?
========================

Gisquick source code update is done with ``pull`` command.

.. code:: sh
$ git pull
Upgrade with Vagrant:

.. code:: sh
$ vagrant up
$ vagrant provision
When there are fundamental changes, it is better to run ``vagrant destroy``
command before ``git pull``.

.. code:: sh
$ vagrant destroy -f
$ git pull
$ vagrant up
.. tip:: |tip| Quick update can be done with ``git pull`` command followed by
running ``$ gulp build-web`` on server.

.. code:: sh
$ git pull && vagrant up && vagrant ssh
$ /vagrant/utils/tmux-dev.sh
$ cd /vagrant/clients
$ gulp build-web
`GNU General Public License version 2
<https://github.com/gislab-npo/gisquick/blob/master/LICENSE>`__ or
later

0 comments on commit 272a1c5

Please sign in to comment.