Docs - Improve deployment and export catalog #60

3liz · Feb 19, 2021 · b14662f · b14662f
1 parent 8a054c3
commit b14662f
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -12,23 +12,9 @@ Store metadata in a PostgreSQL database and manage it from QGIS.
 
 ## Documentation
 
-https://docs.3liz.org/qgis-pgmetadata-plugin/
-
-## Installation
-
-The plugin is not yet available in the official QGIS repository, you must install it manually.
-
-### Custom repository
+Presentation, user guide, installation, Lizmap Web Client, everything is there.
 
-We recommend adding the QGIS 
-[custom repository](https://docs.qgis.org/testing/en/docs/user_manual/plugins/plugins.html#the-settings-tab),
-using this URL `https://github.com/3liz/qgis-pgmetadata-plugin/releases/latest/download/plugins.xml`.
-There isn't any authentication, and you will have automatic updates later.
-
-### Manual ZIP
-
-If you don't want to setup a custom repository, you can download the ZIP file from the
-[release page](https://github.com/3liz/qgis-pgmetadata-plugin/releases)
+https://docs.3liz.org/qgis-pgmetadata-plugin/
 
 ## Running migrations
 

diff --git a/docs/index.md b/docs/index.md
@@ -12,7 +12,8 @@ Some key features for final users :
 
 * a [locator](./user-guide/end-user.md#locator) to easy search and add layers
 * a [dock](./user-guide/end-user.md#panel) to display metadata
-* [some exports](./user-guide/end-user.md#export) to PDF, HTML DCAT, CSV
+* Export a [single](./user-guide/end-user.md#export-a-single-metadata) sheet to PDF, HTML DCAT
+* Export the full [catalog](./user-guide/end-user.md#export-the-catalog)
 
 Some features for the GIS administrator :
 

diff --git a/docs/user-guide/end-user.md b/docs/user-guide/end-user.md
@@ -20,13 +20,21 @@ selected in the legend.
 
 ![Panel](../img/dock_qgis.png)
 
-## Export
+## Export a single metadata
 
-To export metadata as PDF, HTML or DCAT, you need to select a layer in your layer tree saved in the metadata 
-table `dataset`. Then in the dock you have a button to open the `export menu` and choose the output format.
+To export a metadata sheet as PDF, HTML or DCAT, you need to select a layer in your layer tree saved in the 
+metadata table `dataset`. Then in the dock you have a button to open the `export menu` and choose the output
+format.
 
 ![Button Export](../img/dockpgmetadata_with_metadata.png)
 
 If no layer with metadata are selected, you can't click on the button of the `export menu`.
 
 ![Button Export without metadata](../img/dockpgmetadatawithoutmetadata.png)
+
+## Export the catalog
+
+From the dock, it's possible to add a layer in the legend showing the full catalog. The main **dataset** table
+is flatten to show **contacts** and **links** as well.
+
+The user can export this non-spatial layer as CSV by right clicking on the layer then **Export**.
diff --git a/docs/user-guide/sys-admin.md b/docs/user-guide/sys-admin.md
@@ -18,3 +18,9 @@ connection_names=Connection 1;Connection 2;Connection 3
 [Plugins]
 pg_metadata=true
 ```
+
+* `end_user_only` is designed to hide Processing algorithms which are designed for PgMetadata administrator.
+* `connection_names` is a list of connections separated by `;` so PgMetadata knows where to look for metadata.
+
+The last section `Plugins` showed above is to automatically load the plugin if the plugin folder is installed
+by a deployment tool.