website: give more visibility to user-manual

artefactual-labs · Jun 14, 2021 · 6aae443 · 6aae443
1 parent 256ff69
commit 6aae443
Show file tree

Hide file tree

Showing 12 changed files with 104 additions and 50 deletions.
diff --git a/codecov.yml b/codecov.yml
@@ -20,7 +20,9 @@ coverage:
         if_not_found: success
 
 ignore:
+- "build"
 - "hack"
 - "ui"
 - "website"
 - "fake"
+- "gen"
diff --git a/website/assets/scss/_variables_project.scss b/website/assets/scss/_variables_project.scss
@@ -18,6 +18,11 @@ $light: #D3F3EE;
 // Extra variables.
 $e-gray: #888;
 
+// Enduro colors.
+$enduro-c1: #5e2750;
+$enduro-c2: lighten(#5e2750, 10%);
+$enduro-c3: lighten(#5e2750, 15%);
+
 // Make headings smaller.
 $font-size-base: 1rem; // Typically 16px.
 h1 { font-size: $font-size-base * 1.75 !important; }
@@ -102,3 +107,20 @@ form.td-sidebar__search {
 .td-toc #TableOfContents a.active:before {
   background-color: $primary;
 }
+
+// Smaller font size in figure captions.
+figure h4 {
+  font-size: 0.75rem !important;
+}
+
+// Apply colors in Enduro.
+.td-navbar {
+  background-color: $enduro-c1 !important;
+}
+
+footer.bg-dark {
+  background-color: #f5f5f5 !important;
+  small {
+    color: #333 !important;
+  }
+}
diff --git a/website/content/en/docs/api/_index.md b/website/content/en/docs/api/_index.md
@@ -1,7 +1,7 @@
 ---
 title: "API Reference"
 linkTitle: "API Reference"
-weight: 3
+weight: 4
 type: swagger
 description: >
   Enduro API described with OpenAPI.

diff --git a/website/content/en/docs/contribution-guidelines/_index.md b/website/content/en/docs/contribution-guidelines/_index.md
@@ -1,7 +1,7 @@
 ---
 title: "Contribution Guidelines"
 linkTitle: "Contribution Guidelines"
-weight: 5
+weight: 6
 description: >
   How to contribute to Enduro.
 ---
diff --git a/website/content/en/docs/development/_index.md b/website/content/en/docs/development/_index.md
@@ -1,7 +1,7 @@
 ---
 title: "Development"
 linkTitle: "Development"
-weight: 4
+weight: 5
 description: >
   This section aims to introduce developers to our internal development
   practices.

diff --git a/website/content/en/docs/development/environment.md b/website/content/en/docs/development/environment.md
@@ -47,19 +47,18 @@ Now we need to build some Go tools we're going to use during development:
 
     make tools
 
-To build our first binary succesfully, we need to generate the database
-migrations and the web interface with:
+Build the web-based user interface:
 
-    make migrations ui
+    make ui
 
-We're ready to run our first build:
+Finall, build and run Enduro with:
 
     make
 
 With Enduro running in the background, you should be able to access the web
 interface via http://127.0.0.1:9000/ or connect to the API, e.g.:
 
-    curl -v "127.0.0.1:9000/collection/"
+    curl -v 127.0.0.1:9000/collection
 
 ## Set up MinIO for object storage
 

diff --git a/website/content/en/docs/user-manual/_index.md b/website/content/en/docs/user-manual/_index.md
@@ -1,7 +1,8 @@
 ---
 title: "User Manual"
 linkTitle: "User Manual"
-weight: 6
+weight: 3
 description: >
-  For end-users: how to use the Enduro dashboard to import batches of transfers into Archivematica.
+  For end-users: how to use the Enduro dashboard to import batches of transfers
+  into Archivematica.
 ---
diff --git a/website/content/en/docs/user-manual/getting-started.md b/website/content/en/docs/user-manual/getting-started.md
@@ -0,0 +1,70 @@
+---
+title: "Getting Started"
+linkTitle: "Getting Started"
+weight: 1
+description: >
+  Explore the Enduro dashboard and perform a batch import.
+---
+
+## The Enduro dashboard
+
+This is the Enduro Collections dashboard, the default landing page for the
+application. The dashboard lists individual transfers that were part of batch
+ingests and shows their processing status.
+
+* `QUEUED`: The transfer has been included in a batch import and is awaiting
+  ingest into Archivematica.
+* `IN PROGRESS`: The transfer has been ingested into Archivematica and is being
+  processed.
+* `DONE`: The transfer has been processed in Archivematica and the resulting
+  AIP has been placed in archival storage.
+* `ERROR`: The transfer was ingested into Archivematica but an error prevented
+  it from being packaged into an AIP and/or placed in archival storage.
+
+{{< figure src="/dashboard.png" title="Enduro dashboard" >}}
+
+## Preparing transfers for batch import
+
+* Enduro is designed to import and queue up multiple transfers for ingest into
+  Archivematica. In order to prepare your holdings for import, you will need to
+  place your transfers in a location that your administrator has set up for this
+  purpose.
+* Once your transfers are in place, you will be telling Enduro where to look for
+  them to start the import process. You will be directing Enduro to look in a
+  given parent directory, and when it does it will import all of the top-level
+  subdirectories in that parent directory.
+* For example, if you create a top-level directory called *EnduroTests*, and
+  place subdirectories called *Nature*, *Household items* and *Buildings*
+  inside it, Enduro will consider each of those subdirectories to be transfers
+  (regardless of the directory structure within those subdirectories).
+
+  {{< figure src="/sample-hierarchy.png" title="EnduroTests" width="50%" >}}
+
+## Starting a batch import
+
+* To start a new batch ingest, click on Batch import in the upper right corner
+  of the Collections tab. This will open a new batch import page.
+* Enter the path of the directory containing the transfers to be ingested.
+* Enter the name of the Archivematica processing pipeline that will be used to
+  perform the ingest.
+* Click Submit. Note that the page does not change when Submit is clicked -
+  don't re-click.
+
+  {{< figure src="/batch-import.png" title="Batch import" >}}
+
+* Return to the Collections page. You will see a set of new transfers, likely
+  with a status of QUEUED or IN PROGRESS.
+* As each transfer is processed into an AIP and placed in archival storage, its
+  status will change to DONE. Congratulations! You have just used Enduro to
+  perform batch processing!
+* NOTE: Enduro will automatically used the "automated" processing configuration
+  file in the selected Archivematica pipeline for each transfer.
+* NOTE: If you have your Archivematica dashboard open you will see the
+  transfers appearing in the Archivematica transfer tab and then in the ingest
+  tab. Once the transfers have finished processing and the AIP has been placed
+  in archival storage, however, the transfers will no longer be visible in the
+  transfer and ingest tabs. Enduro has cleared them ot of those tabs in order
+  to ensure that the tabs don't get cluttered. However, if an error has occurred
+  and the Enduro Collections tab shows a status of ERROR, the failed transfer
+  remains visible in the transfer and/or ingest tabs (depending on which
+  micro-service failed).
diff --git a/website/content/en/docs/user-manual/gettingstarted.md b/website/content/en/docs/user-manual/gettingstarted.md
diff --git a/website/static/batch-import.png b/website/static/batch-import.png
diff --git a/website/static/dashboard.png b/website/static/dashboard.png
diff --git a/website/static/sample-hierarchy.png b/website/static/sample-hierarchy.png
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,7 +20,9 @@ coverage: @@
             if_not_found: success
     ignore:
+    - "build"
     - "hack"
     - "ui"
     - "website"
     - "fake"
+    - "gen"