Skip to content

Commit 2676c07

Browse files
pvgenuchtenPaul van Genuchten
and
Paul van Genuchten
authored
some textual improvements on management commands (#214)
Co-authored-by: Paul van Genuchten <[email protected]>
1 parent cf0be52 commit 2676c07

File tree

2 files changed

+38
-22
lines changed

2 files changed

+38
-22
lines changed

admin/index.rst

+14-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ GeoNode has an administration panel, based on the Django admin, which can be use
55
Although most of the operations can and should be done through the normal GeoNode interface,
66
the admin panel provides a quick overview and management tool over the database.
77

8-
The following sections will explain more in depth what functionalities the admin panel makes you available.
8+
The following sections will explain more in depth what functionalities the admin panel makes available to you.
99
It should be highlighted that the sections not covered in this guide are meant to be managed through GeoNode UI.
1010

1111
.. toctree::
@@ -16,6 +16,19 @@ It should be highlighted that the sections not covered in this guide are meant t
1616
GeoNode Management Commands
1717
===========================
1818

19+
Managemant commands are utility functions for GeoNode maintenance tasks. They are usually run from an SSH/bash shell on the server running GeoNode.
20+
Any call to python is prepended with a configuration parameter to indicate the GeoNode settings module to be used.
21+
22+
.. code-block:: shell
23+
24+
DJANGO_SETTINGS_MODULE=geonode.settings python manage.py migrate_baseurl --help
25+
26+
.. note:: If you have enabled ``local_settings.py`` the command will change as follows:
27+
28+
.. code-block:: shell
29+
30+
DJANGO_SETTINGS_MODULE=geonode.local_settings python manage.py migrate_baseurl --help
31+
1932
.. toctree::
2033
:caption: GeoNode Management Commands
2134
:maxdepth: 3

admin/mgmt_commands/index.rst

+24-21
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,6 @@ Run
1818
1919
DJANGO_SETTINGS_MODULE=geonode.settings python manage.py migrate_baseurl --help
2020
21-
.. note:: If you enabled ``local_settings.py`` the command will change as following:
22-
23-
.. code-block:: shell
24-
25-
DJANGO_SETTINGS_MODULE=geonode.local_settings python manage.py migrate_baseurl --help
26-
2721
This will produce output that looks like the following
2822

2923
.. code-block:: shell
@@ -361,15 +355,13 @@ Loading Data into GeoNode
361355
362356
There are situations where it is not possible or not convenient to use the
363357
:guilabel:`Upload Form` to add new Datasets to GeoNode via the web interface.
364-
As an instance:
365-
366-
* The dataset is simply too big to be uploaded through a web interface.
358+
For instance:
367359
368-
* We would like to import some data from the mass storage programmatically.
360+
* The dataset is too big to be uploaded through a web interface.
369361
370-
* We would like to import some tables from a DataBase.
362+
* Import data from a mass storage programmatically.
371363
372-
* We need to process the data first and, maybe, transform it to another format.
364+
* Import tables from a database.
373365
374366
This section will walk you through the various options available to load data into your
375367
GeoNode from GeoServer, from the command-line or programmatically.
@@ -411,9 +403,9 @@ This will produce output that looks like the following
411403
[--force-color] [--skip-checks]
412404
[path [path ...]]
413405
414-
Brings a directory full of data files into a GeoNode site.
415-
Datasets are added to the Django database, the GeoServer configuration, and the
416-
pycsw metadata index.
406+
Brings files from a local directory, including subfolders, into a GeoNode site.
407+
The datasets are added to the Django database, the GeoServer configuration, and the
408+
pycsw metadata index. At this moment only files of type Esri Shapefile (.shp) and GeoTiff (.tif) are supported.
417409
In order to perform the import, GeoNode must be up and running.
418410
419411
positional arguments:
@@ -448,7 +440,7 @@ reviewing some of the key options a bit more in details.
448440
449441
The import Datasets management command is invoked by specifying options as described
450442
above and specifying the path to a directory that contains multiple files. For purposes of this exercise, let's use the default set of testing Datasets that ship with geonode.
451-
You can replace this path with the directory to your own shapefiles.
443+
You can replace this path with a directory to your own shapefiles.
452444
453445
.. code-block:: shell
454446
First let's run the GeoNode server:
@@ -508,11 +500,10 @@ While it is possible to import Datasets directly from your servers filesystem in
508500
GeoNode, you may have an existing GeoServer that already has data in it, or you may
509501
want to configure data from a GeoServer which is not directly supported by uploading data.
510502
511-
GeoServer supports a wide range of data formats and connections to database, and while
512-
many of them are not supported as GeoNode upload formats, if they can be configured in
513-
GeoServer, you can add them to your GeoNode by following the procedure described below.
503+
GeoServer supports a wide range of data formats and connections to database, some of them
504+
may not be supported as GeoNode upload formats. You can add them to your GeoNode by following the procedure described below.
514505
515-
GeoServer supports 3 types of data: :guilabel:`Raster`, :guilabel:`Vector`, :guilabel:`Databases` and :guilabel:`Cascaded`.
506+
GeoServer supports 4 types of data: :guilabel:`Raster`, :guilabel:`Vector`, :guilabel:`Databases` and :guilabel:`Cascaded`.
516507
517508
For a list of the supported formats for each type of data, consult the following pages:
518509
@@ -638,6 +629,18 @@ First visit the GeoServer administration interface on your server. This is usual
638629
-p PERMISSIONS, --permissions PERMISSIONS
639630
Permissions to apply to each Dataset
640631
632+
The update procedure includes the following steps:
633+
634+
- The process fetches from GeoServer the relevant WMS layers (all, by store or by workspace)
635+
636+
- If a filter is defined, the GeoServer layers are filtered
637+
638+
- For each of the layers, a GeoNode dataset is created based on the metadata registered on GeoServer (title, abstract, bounds)
639+
640+
- New layers are added, existing layers are replaced, unless the :guilabel:`--skip-geonode-registered` option is used
641+
642+
- The GeoNode layers, added in previous runs of the update process, which are no longer available in GeoServer are removed, if the :guilabel:`--remove-delete` option is set
643+
641644
.. warning:: One of the :guilabel:`--workspace` or :guilabel:`--store` must be always specified if you want to ingest Datasets belonging to a specific ``Workspace``. As an instance, in order to ingest the Datasets present into the ``geonode`` workspace, you will need to specify the option ``-w geonode``.
642645
643646
9. Let's ingest the Dataset ``geonode:_1_SARMIENTO_ENERO_2018`` from the ``geonode`` workspace.
@@ -854,7 +857,7 @@ First visit the GeoServer administration interface on your server. This is usual
854857
0 Failed Datasets
855858
5.000000 seconds per Dataset
856859
857-
.. note:: In case you don't specify the :guilabel:`-f` option, the Datasets that already exist in your GeoNode will be just updated and the configuration synchronized between GeoServer and GeoNode.
860+
.. note:: In case you don't specify the :guilabel:`-f` option, the Datasets that already exists in your GeoNode will be just updated and the configuration synchronized between GeoServer and GeoNode.
858861
859862
.. warning:: When updating **from** GeoServer, the configuration on GeoNode will be changed!
860863

0 commit comments

Comments
 (0)