documentation

cityssm · Jun 25, 2021 · 580a349 · 580a349
1 parent 12cbaf5
commit 580a349
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 7 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -6,9 +6,6 @@
 
 ![Login Screen](login.png)
 
-**[Setup and Configuration](setup.md)**<br />
-The config.js file.  The database configuration tables.
-
 **[Finding Records](search.md)**<br />
 Searching and filtering like a pro.
 
@@ -17,3 +14,11 @@ And how to delete records too.
 
 **[Reporting Options](reporting.md)**<br />
 Export data in the Excel-friendly CSV format.
+
+## System Administrator Documentation
+
+**[Setup and Configuration](setup.md)**<br />
+The config.js file.  The database configuration tables.
+
+**[Administration](admin.md)**<br />
+The administrative views for maintaining users, record types, and status types.
diff --git a/docs/admin-recordTypes.png b/docs/admin-recordTypes.png
diff --git a/docs/admin.md b/docs/admin.md
@@ -0,0 +1,21 @@
+[Home](https://cityssm.github.io/corporate-records-manager/)
+·
+[Documentation](./)
+
+# Administration
+
+![Record Type Administration](admin-recordTypes.png)
+
+Administrators have the ability to make changes to the following configuration tables.
+
+-   Users
+-   Record Types
+-   Status Types
+
+These tables are documented in the [Setup documentation](setup.md).
+
+## General Notes
+
+-   Only items not associated with records can be fully removed.  Items that cannot be removed can be hidden from view by being set as inactive.
+
+-   When updating record types and status types, be sure not to change the meaning of the type.  For example, if a status type of "New" is renamed to "Expired", all those records using that status will be updated as well.  When in doubt, create a new type, and mark the old one as inactive.
diff --git a/docs/setup.md b/docs/setup.md
@@ -66,10 +66,11 @@ DocuShare integrations are powered by
 
 ## Database Tables
 
-At the time of this writing, there are no administrative views
-for maintaining the configuration tables.
-Once set up, ongoing maintenance is minimal.
-It is recommended to use a tool like SQL Server Management Studio to make changes.
+To update the configuration tables graphically,
+see the [Administration documentation](admin.md).
+
+Alternatively, you can manually update the configuration tables.
+using a tool like [SQL Server Management Studio](https://docs.microsoft.com/en-us/sql/ssms/download-sql-server-management-studio-ssms).
 
 ### CR.Users