diff --git a/docs/source/guide_administrator.rst b/docs/source/guide_administrator.rst index 361f235778aea31a29e9dc99cd955d645009faab..f4fb934c0e0203cd47a35a916925b5e0db673dea 100644 --- a/docs/source/guide_administrator.rst +++ b/docs/source/guide_administrator.rst @@ -1,4 +1,4 @@ -.. _guide_user: +.. _guide_administrator: PEDASI Administration Guide =========================== @@ -14,6 +14,9 @@ PEDASI Administration Guide Deploying PEDASI in Production ------------------------------ +Overview +^^^^^^^^ + A deployment of PEDASI is done automatically to a remote Ubuntu server via a preconfigured Ansible script, which performs the following tasks: 1. @@ -30,14 +33,14 @@ Ensure you have the following prerequisites before you begin: - A static IP address - A user account with external SSH access enabled and with sudo access privileges (e.g. 'ubuntu' - ubuntu will be used throughout this documentation) - - A Linux or Mac OS X local machine with: + - A Linux or Mac OS X local machine with the following installed: - - Ansible v2.7.1 or above installed - - Git command line client v2 or above installed + - Ansible v2.7.1 or above + - Git command line client v2 or above -Cloning out the PEDASI Repository -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Cloning the PEDASI Repository +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ On your local machine, first clone the PEDASI repository: @@ -59,15 +62,19 @@ Deployment Managing Data Sources --------------------- + Adding a Data Source ^^^^^^^^^^^^^^^^^^^^ + Updating a Data Source ^^^^^^^^^^^^^^^^^^^^^^ + Removing a Data Source ^^^^^^^^^^^^^^^^^^^^^^ + Approving Data Access Requests ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -75,12 +82,15 @@ Approving Data Access Requests Managing Applications --------------------- + Adding an Application ^^^^^^^^^^^^^^^^^^^^^ + Updating an Application ^^^^^^^^^^^^^^^^^^^^^^^ + Removing an Application ^^^^^^^^^^^^^^^^^^^^^^^