Further additions

geobtaa · Sep 16, 2024 · e06d04e · e06d04e
1 parent e4e205c
commit e06d04e
Show file tree

Hide file tree

Showing 12 changed files with 101 additions and 53 deletions.
diff --git a/docs/admin-tools.md b/docs/admin-tools.md
@@ -6,7 +6,7 @@ The Admin Tools menu item is a dropdown listing various functions. These functio
 
 ### Documents
 
-This link shows all the documents in the Dashboard. (It is a duplicate of the default homepage.)
+This link shows all the documents. (It is a duplicate link of the default home landing page.)
 
 ### Imports
 
@@ -20,7 +20,7 @@ This link shows a list of batch edits a user has generated, such as setting the
 
 ### Assets
 
-This link directs to a dashboard displaying uploaded objects. Click on the "Upload Assets" button to manually upload a dataset, thumbnail, or supplemental metadata file.
+This link directs to a page displaying uploaded objects. Click on the "Upload Assets" button to manually upload a dataset, thumbnail, or supplemental metadata file.
 
 ### Access Links
 

diff --git a/docs/create.md b/docs/create.md
@@ -1,8 +1,8 @@
-# Create a record
+# Create a single record
 
 Users can manually create records using the form view. 
 
-1. Start on the main dashboard
+1. Start on the main Documents page
 2. click the button labeled **+New Document**
 3. Manually type in values. Some fields are required and need to be entered before the record can be saved including:
 	* Title

diff --git a/docs/images/adminTools.png b/docs/images/adminTools.png
diff --git a/docs/images/dashboard.png b/docs/images/dashboard.png
diff --git a/docs/images/documents.png b/docs/images/documents.png
diff --git a/docs/images/formView.png b/docs/images/formView.png
diff --git a/docs/images/toolbar.png b/docs/images/toolbar.png
diff --git a/docs/import.md b/docs/import.md
@@ -2,11 +2,15 @@
 
 Users can use this page to batch create or edit records with a CSV file.
 
+## Primary Table
+
+The Primary table holds the metadata for each item.
+
 1. Create a CSV using the Label for each OGM Aardvark metadata field
 
-!!! warning "to do"
+!!! tip
 
-	Need to create a doc showing all the fields and References labels. [Use the B1G Template](https://z.umn.edu/b1g-template)
+	Copy the [B1G Template](https://z.umn.edu/b1g-template) for an example of an importable CSV.
 
 2. Upload the spreadsheet to GeoBlacklight Admin
 
@@ -24,31 +28,37 @@ Users can use this page to batch create or edit records with a CSV file.
 
 3. Spot check records for errors and consistency
 
-	- The newly uploaded records will be listed as **Draft** under the Publication State on the main dashboard
+	- The newly uploaded records will be listed as **Draft** under the Publication State on the main Documents view.
 	- Select 'Draft' under Publication State and select an item. This will open it in editing view.
 	- Click the button **View in Geoportal**
 	- Inspect the record and test the links.	- Repeat this process for about 3 records.
 
 
 4. Convert records from 'Draft' to 'Published'
 
-	- If the records are satisfactory, return to the Dashboard view and select all Draft items in the upload. 
+	- If the records are satisfactory, return to the Documents view and select all Draft items in the upload. 
 	- Select All and then select the text "Select all results that match this search"
 	- Click the State button. From the dropdown, select Published.
 	- On the _Bulk Action_ page, click the button **Run Bulk Action**
 	- Review 3-5 of the published records and test all the links.
 
 ## Secondary tables
 
-There are two metadata fields, `Multiple Download Links` and `Institutional Access Links` that use secondary tables. This occurs when the field needs parts to the value: a label + a link. 
+Secondary tables are for selected external links and assets/file attachments.
+
+### External Links
+
+`Multiple Download Links` and `Institutional Access Links` use secondary tables.
 
 * When using the Form view, these values can be entered directly.
-* For CSV uploads, these values use a separate sheet than for the main import template.
-* Multiple Download Links: 
+* For CSV uploads, these values use a different template than for the Primary table.
+
+* **Multiple Download Links**: 
 	- on the Form view, scroll down to the Multiple Download Links inside the editor
 	- to enter manually, click the New Download URL button
 	- to upload multiple links, click the Import CSV button
-* Institutional Access Links
+
+* **Institutional Access Links**:
 	- on the Form view, click the text "Institutional Access Links" on the bottom of the right hand navigation OR go to Admin Tools - Access Links
 	- to enter manually, click the New Access URL button
 	- to upload multiple links, click the Import CSV button
@@ -73,3 +83,8 @@ There are two metadata fields, `Multiple Download Links` and `Institutional Acce
         ```
 
 
+### Assets/File Attachments
+
+!!! warning "in development"
+
+	This feature is currently in development
diff --git a/docs/layout.md b/docs/layout.md
diff --git a/docs/toolbar.md b/docs/toolbar.md
@@ -0,0 +1,31 @@
+# Toolbar
+
+The top toolbar is available on all pages. It contains the following links:
+
+## GBL♦Admin
+Link to the Documents view
+
+## Search Documents
+
+A box for keyword searching
+
+## Advanced
+
+Links to the Advanced Search page
+
+## Notifications
+
+The Notificiations tab displays generated metadata download files. When a user requests a set of files for export, GeoBlacklight Admin will dynamically generate the download. Once the files are ready, the Notifications tab will display a red visual indicator.
+
+
+## Admin Tools
+
+The Admin Tools is a dropdown menu item that contains links to the various actions. See the [Admin Tools page](admin-tools.md) for descriptions.
+
+## User Name
+
+This lists the logged-in user name with dropdown options for bookmarks, editing your profile, and logging out.
+
+## GeoBlacklight Home
+
+Opens the homepage of the integrated GeoBlacklight instance.
diff --git a/docs/views.md b/docs/views.md
@@ -0,0 +1,32 @@
+# Views
+
+There are two main document views: Documents and Form View.
+
+## Documents
+
+The Documents shows a list of all records in the index. These can be selected or filtered. The search functionality mimics the GeoBlacklight interface with a list of facets on the left to filter records. 
+
+It also features:
+
+* Date Range filter: to select items by Date Created (when they were first added).
+* Imports: Shortcut to filter to specific CSV metadata imports.
+
+![](images/documents.png)
+
+
+----------
+## Form view
+
+This page provides all of the editable fields for an individual record. Users can create new records or edit existing records manually with the Form view.
+
+to access the Form view, click on a record in the Documents list or click the button "New Document".
+
+![](images/formView.png)
+
+!!! tip
+
+	Click on the button "View Geoportal" to open a new tab with the record live in GeoBlacklight. Note: the record is still viewable live via this button, even if it is a Draft or Unpublished.
+
+------------
+
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -9,11 +9,17 @@ markdown_extensions:
   - admonition
   - pymdownx.details
   - pymdownx.superfences
+  - attr_list
+  - md_in_html
 
 nav:
 - Home: 'index.md'
-- Layout: 'layout.md'
-- Create a record: 'create.md'
-- Import records: 'import.md'
-- Select records: 'select.md'
-- Admin Tools: 'admin-tools.md'
+- Layout:
+      - Toolbar: 'toolbar.md'
+      - Views: 'views.md'
+      - Admin Tools: 'admin-tools.md'
+
+- How to:
+      - Create a record: 'create.md'
+      - Import records: 'import.md'
+      - Select records: 'select.md'