Populate sysadmin settings (#283)

* populate sysadmin settings * Update docs/src/administrator/manual/sysadmin-settings.md Co-authored-by: Jeremy-Prior <[email protected]> * Update docs/src/administrator/manual/sysadmin-settings.md Co-authored-by: Jeremy-Prior <[email protected]> * Update docs/src/administrator/manual/sysadmin-settings.md Co-authored-by: Jeremy-Prior <[email protected]> * Update sysadmin-settings.md * update nav-bar and sysadmin content * update mkdocs-base --------- Co-authored-by: Jeremy-Prior <[email protected]>
kartoza · Jan 24, 2024 · 3037a0b · 3037a0b
1 parent fbd99cf
commit 3037a0b
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 2 deletions.
diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml
@@ -85,7 +85,9 @@ nav:
                         - Dashboard: administrator/manual/dashboard.md
                         - Harvest Settings: administrator/manual/harvesting-settings.md
                         - Usage Statistics: administrator/manual/usage-statistics.md
+                        - Sysadmin Settings: administrator/manual/sysadmin-settings.md
                         - Metadata Validator: administrator/manual/metadata-validator.md
+
         - Developers:
                 - developer/index.md
                 - Guide:

diff --git a/docs/src/administrator/manual/img/sysadmin-settings-1.png b/docs/src/administrator/manual/img/sysadmin-settings-1.png
diff --git a/docs/src/administrator/manual/img/sysadmin-settings-2.png b/docs/src/administrator/manual/img/sysadmin-settings-2.png
diff --git a/docs/src/administrator/manual/img/sysadmin-settings-3.png b/docs/src/administrator/manual/img/sysadmin-settings-3.png
diff --git a/docs/src/administrator/manual/img/sysadmin-settings-4.png b/docs/src/administrator/manual/img/sysadmin-settings-4.png
diff --git a/docs/src/administrator/manual/img/sysadmin-settings-5.png b/docs/src/administrator/manual/img/sysadmin-settings-5.png
diff --git a/docs/src/administrator/manual/index.md b/docs/src/administrator/manual/index.md
@@ -10,9 +10,11 @@ The administrator manual aims to assist user in learning the fundamentals of usi
 
 ## Index
 
-- [**Dashboard**]()
+- [**Profile**](./profile.md)
 - [**Harvesting Settings**](./harvesting-settings.md)
-- [**Profile**]()
+- [**Dashboard**](./dashboard.md)
+- [**Usage Statistics**](./usage-statistics.md)
+- [**Sysadmin Settings**](./sysadmin-settings.md)
 - [**Metadata**]()
 - [**STAC Harvesting**](./stac-harvester.md)
 - [**Map**]()

diff --git a/docs/src/administrator/manual/sysadmin-settings.md b/docs/src/administrator/manual/sysadmin-settings.md
@@ -0,0 +1,39 @@
+# Sysadmin settings
+
+Sysadmin settings are designed to provide administrator access to manage accounts, organisations, and datasets. Certain 
+administration tasks are unavailable through the web UI but require access to the server where CKAN is installed. 
+This manual covers the administration features in the web UI.
+
+![sysadmin settings](./img/sysadmin-settings-1.png)
+
+1. Click on the `Sysadmin settings` option to have control of CKAN's instance. 
+
+![sysadmin settings](./img/sysadmin-settings-2.png)
+
+
+## Sysadmins
+
+The first tab, `Sysadmin`, has the list of all sysadmin users. By clicking on one user, the administrator can manage 
+the user account as if it were in the [profile](profile.md).
+
+![sysadmin settings](./img/sysadmin-settings-3.png)
+
+
+## Config
+
+The second tab, `Config`,  is a page where the administrator can change some configurations from the web interface. 
+It is a simple interface to quickly customise the `look and feel` of CKAN.
+
+![sysadmin settings](./img/sysadmin-settings-4.png)
+
+
+## Trash
+
+The third tab, `Trash`, is a page that shows all deleted datasets, organisations, and groups. It allows the 
+administrator to delete them permanently.
+
+![sysadmin settings](./img/sysadmin-settings-5.png)
+
+1. **Purge all**: To remove permanently all deleted datasets, organisations, and groups.
+2. **Purge**: To remove permanently all deleted metadata records
+3. **Purge**: To remove permanently all deleted organisation