diff --git a/docs/source/guide_user.rst b/docs/source/guide_user.rst index 2b4de1eb4d4023b2a8744d6f8f90db25aefd9ef8..cd2f8edbca7b266bf8c41fd9394b9f4e5effe7e7 100644 --- a/docs/source/guide_user.rst +++ b/docs/source/guide_user.rst @@ -8,9 +8,56 @@ PEDASI User Guide :caption: Contents: +User Model +---------- + +There are three classes of users within PEDASI: + + - *Basic User*: these are anonymous users, able to browse and search the catalogue's public data sources and associated metadata, and retrieve public datasets from those data sources. They can also request a *PEDASI User* account. The data access activities of Basic Users are not tracked by PEDASI. + + - *PEDASI User*: in addition to what a Basic User can do, these users can also request access to specific data sources, which may be approved by *Data Providers*. These users are also *observed* within PEDASI, with data access activities tracked by the system (for those data sources that opt to track user activities). + +Two other types of user types exist for administering PEDASI data sources and applications, that build on what PEDASI Users can do: + + - *Data Provider*: these users may register new data sources within PEDASI, update data sources and their metadata, remove data sources, and approve data source access requests. + + - *Application Provider*: similarly, these users may register new applications within PEDASI, update applications and their metadata, and remove applications. + +Applications developed for PEDASI also function as PEDASI Users, having their data access activities optionally tracked within the system, depending on the configuration of data sources. + +There is also a PEDASI *Central Administrator* user, able to approve PEDASI User account requests, and assign/remove Data and Application Provider roles to users. + + +Registering for a PEDASI Account +-------------------------------- + +The preferred method to register an account with PEDASI is to register your Google account. If you don't have a Google account, you can `sign up for one`_. Once you have an account, you should contact the PEDASI Central Administrator via their contact details and request that your account be added to the system. + +Once approved, log in to the system using your Google account by selecting *Google Login* on the front page. + +.. _`sign up for one`: https://accounts.google.com/signup + + +Browsing the Data Catalogue +--------------------------- + + + +Viewing data sources +^^^^^^^^^^^^^^^^^^^^ + +Requesting Access to a Datasource +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Using the Data Explorer +^^^^^^^^^^^^^^^^^^^^^^^ + + + + References -********** +---------- * :ref:`genindex` * :ref:`modindex` diff --git a/docs/source/index.rst b/docs/source/index.rst index 99ef440fa37af2cc8cd20257ba5666f9998c261c..cdb4c31855fbc8af56ce119ebe6fb84d1905dfe9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,7 +9,7 @@ PEDASI Overview -******** +-------- Developed as a platform and a service to explore research challenges in data security, privacy, and ethics, PEDASI enables providers of data - particularly `Internet of Things`_ data - to share their data securely within a common catalogue for use by application developers and researchers. Data can either be hosted and made accessible directly within PEDASI as an internal data source, or hosted elsewhere and accessible as an external data source through PEDASI. @@ -19,7 +19,7 @@ An initial deployment of the platform is available at https://dev.iotobservatory Key Features -************ +------------ PEDASI's key features are: @@ -33,9 +33,9 @@ PEDASI's key features are: Resources -********* +--------- -Documentation is available within this repository for the following stakeholders: +Documentation is available for the following stakeholders: - :ref:`Researchers and other end-users<guide_user>`: to discover, explore, and make use of datasets using the web interface - :ref:`Administrators<guide_administrator>`: to deploy PEDASI, or provide data or use applications through PEDASI @@ -47,13 +47,13 @@ This documentation is also available on `Read the Docs`_. License -******* +------- PEDASI is provided under the MIT licence. References -********** +---------- * :ref:`genindex` * :ref:`modindex`