Added the administration section

TripalCultivate · Jan 4, 2024 · 82ef5bf · 82ef5bf
1 parent bd697ce
commit 82ef5bf
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 0 deletions.
diff --git a/_data/toc.yml b/_data/toc.yml
@@ -1,3 +1,12 @@
+- title: "Administration Documentation"
+  url: docs/administration/administration
+  links:
+    - title: "Installation"
+    url: docs/administration/installation
+    - title: "Setup and Configuration"
+    url: docs/administration/configuration
+    - title: "Ongoing Site Management"
+    url: docs/administration/management
 - title: "Curation, File Upload and Management"
   url: docs/curation/curation
   links:

diff --git a/_docs/administration/administration.md b/_docs/administration/administration.md
@@ -0,0 +1,15 @@
+---
+title: Administration Documentation
+description: This documentation is designed to guide tasks related to administration (including install, configuration and management) of TripalCultivate modules.
+---
+# Administration
+This section of the documentation is designed to guide a site administrator to install, configure and manage any of the TripalCultivate modules.
+
+## [Installation](installation)
+Find out what the requirements are, how to select the right modules for your site's needs, and what order to install them in this section.
+
+## [Setup and Configuration](configuration)
+After a module has been installed, there is some configuration that takes place before it is ready for use. This includes setting of controlled vocabulary terms, default values for forms and more.
+
+## [Ongoing Site Management](management)
+Tasks that occur semi-regularly such as file management, publishing new content, and updating materialized views are explained here.
diff --git a/_docs/administration/configuration.md b/_docs/administration/configuration.md
@@ -0,0 +1,5 @@
+---
+title: Setup and Configuration Documentation
+description: This documentation is designed to guide an administrator how to setup and configure any of the Tripalcultivate modules so that it is ready for data curators and site users.
+---
+# Setup and Configuration
diff --git a/_docs/administration/installation.md b/_docs/administration/installation.md
diff --git a/_docs/administration/management.md b/_docs/administration/management.md
@@ -0,0 +1,11 @@
+---
+title: Ongoing Module Management Documentation
+description: This documentation is designed to guide an administrator how to manage on an ongoing basis any of TripalCultivate modules.
+---
+# Ongoing Module Management
+
+## File Management
+
+## Publishing Content
+
+## Updating Materialized Views