Include private dataset section in User Guide

conwetlab · Dec 4, 2017 · 58a8ce3 · 58a8ce3
1 parent 2b13982
commit 58a8ce3
Show file tree

Hide file tree

Showing 8 changed files with 56 additions and 0 deletions.
diff --git a/doc/images/private1.png b/doc/images/private1.png
diff --git a/doc/images/private2.png b/doc/images/private2.png
diff --git a/doc/images/private3.png b/doc/images/private3.png
diff --git a/doc/images/private4.png b/doc/images/private4.png
diff --git a/doc/images/private5.png b/doc/images/private5.png
diff --git a/doc/images/private6.png b/doc/images/private6.png
diff --git a/doc/images/private7.png b/doc/images/private7.png
diff --git a/doc/user-programmer-guide.rst b/doc/user-programmer-guide.rst
@@ -42,6 +42,62 @@ Once done, the browser is redirected back to CKAN with the user signed in
 Private Datasets
 ----------------
 
+The Private Datasets extension enhance the default dataset access control in CKAN by allowing dataset owners to specify
+what users of the platform can access to the data, even if they are not part of the same organization.
+
+Additionally, it establishes the basic mechanism for acquiring access to the data by allowing to discover private datasets
+and configuring the site where this access can be acquired.
+
+All these options can be configured in the dataset creation form, so the first step is clicking on *Add Dataset*
+
+.. image:: images/private1.png
+   :align: center
+   :scale: 50%
+
+In this form, the extension integrates a set of fields to be filled by the dataset owner
+
+.. image:: images/private2.png
+   :align: center
+   :scale: 50%
+
+In particular:
+
+* **Visibility**: Public or Private
+* **Searchable**: True or false, whether a dataset set as private can be discovered by users, that is, it appears in searches
+* **Allowed Users**: List of platform users authorized to access to the data when the dataset has been set as private
+* **Acquire URL**: URL where it is possible to acquire access grants to the data
+
+Depending of the chosen configuration and access rights of the users, datasets will appear in a different way. A private dataset
+created by the user logged in will appear as:
+
+.. image:: images/private3.png
+   :align: center
+   :scale: 50%
+
+While a private dataset set as searchable will be seen as follows by an user without permissions.
+
+.. image:: images/private4.png
+   :align: center
+   :scale: 50%
+
+If the dataset also has an *Acquire URL*, a button to access to the site will appear
+
+.. image:: images/private5.png
+   :align: center
+   :scale: 50%
+
+Finally, private datasets will be seen as follows for those users who has access permissions
+
+.. image:: images/private6.png
+   :align: center
+   :scale: 50%
+
+These *acquired* datasets are also located in the user dashboard under the *Acquired Datasets* tab
+
+.. image:: images/private7.png
+   :align: center
+   :scale: 50%
+
 ---------
 NGSI View
 ---------