Skip to content

Commit d094234

Browse files
authored
Merge pull request #242 from alliomeria/1.6.0
Various minor docs updates for 1.6.0+
2 parents 23f1a35 + 7d5f540 commit d094234

15 files changed

Lines changed: 31 additions & 20 deletions

docs/AMIviaSpreadsheets.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,9 @@ If you clicked on the 'see it here' link in Step 6, you will be brought to the A
113113

114114
You may wish to double check the settings configured in your AMI Set in the Raw Metadata (JSON) on the AMI Set `View` tab before Processing.
115115

116-
![AMI Set Admin Review](images/AMIsetAdminReview_updated_2025_July.png)
116+
![AMI Set Admin Review](images/AMIsetAdminReview_1-6-0.png)
117117

118-
![AMI Admin Set Process](images/AMIsetAdminProcess_updated_2025_July.png)
118+
![AMI Admin Set Process](images/AMIsetAdminProcess_1-6-0.png)
119119

120120
To Process this set, navigate to the `Process` tab. You will have multiple options related to the Processing outcome for your AMI Set.
121121

@@ -167,7 +167,7 @@ You can view an AMI Set's Report tab either directly within the AMI Set, top tab
167167
- a `message` summarizing the Processing outcome--including a title/label link to the created ADO if successful
168168
- a `details` summary containing system information related to the operations.
169169

170-
![AMI Sets Page Report Operation](images/AMIreportOverview_updated_2025_July.png)
170+
![AMI Sets Page Report Operation](images/AMIreportOverview_1-6-0.png)
171171

172172
You can use information found in the Reports tab to identify review your created ADOs one-by-one and identify any errors or issues that may have come up during the Process if needed.
173173

@@ -177,6 +177,8 @@ At the bottom of the AMI Report tab (for Archipelago 1.5.0 and up), you will see
177177

178178
Lastly, you may wish to run a batch Action against your already-processed ADOs for a particular AMI Set. Using the 'Run Action on Processed ADOs' tab for an AMI Set, you can select from the [available Actions](find_and_replace.md#available-actions) found in your Archipelago instance. The most common Actions you might wish to run for an AMI Set's ADOs include 'Publish' or 'Unpublish', and 'Trigger Strawberrry Runners process/reprocess for Archipelago Digital Objects content item' (read more about [Archipelago's Strawberry Runners Post-Processing Options here](strawberryrunners.md)).
179179

180+
![AMI Sets Run Action on Processed ADOS](images/AMIrunaction_1-6-0.png)
181+
180182
#### Important Note about AMI's ADO Deletion Operations
181183

182184
!!! note "Important Note: Deletion Process"

docs/ami_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ tags:
1515

1616
You can access AMI through the `AMI Sets` tab on the main Content page found at `/admin/content` or directly at `/amiset/list`.
1717

18-
![AMI Sets List Updated](images/AMIsetsList_1-5-0.png)
18+
![AMI Sets List Updated](images/AMIsetsList_1-6-0.png)
19+
20+
* _Easter Egg for 1.6.0+ release: you can sort the AMI Set List by the Set ID, to help you navigate quickly to your most recent AMI set._
1921

2022
## AMI Guides
2123

docs/ami_lod_rec.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,11 @@ Your source spreadsheet will also need to contain at least one column containing
2121

2222
From the main AMI Sets List page, click on your AMI Set's Name, or select the 'Edit' option from the Operations menu on the right-hand side of the Sets list.
2323

24-
![AMI Sets List](images/ami/AMIsetsList.jpg)
24+
![AMI Sets List](images/AMIsetsList_1-6-0.png)
2525

2626
## Step 2: Reconcile LoD Tab
2727

28-
Navigate to the Reconcile LoD tab.
29-
30-
![Reconcile LoD Tab](images/ami/AMIreconcileLodTab.jpg)
28+
Navigate to the 'Reconcile LoD' tab for your selected AMI Set.
3129

3230
## Step 3: LoD Reconciling Selections
3331

@@ -37,7 +35,7 @@ Under the LoD Sources section, select how your chosen Columns will be LoD reconc
3735
- LoD reconcile options will be on the left, LoD Authority Sources will be on the right.
3836
- Example: 'local_subjects' will be mapped to 'LoC subjects (LCSH)'
3937

40-
![AMI LoD Sources](images/ami/AMI_LodSources.jpg)
38+
![AMI LoD Sources](images/AMI_LodSources_1-6-0.png)
4139

4240
??? info "Full list of potential LoD Authority Sources"
4341

@@ -59,9 +57,10 @@ Under the LoD Sources section, select how your chosen Columns will be LoD reconc
5957
- VIAF
6058
- Getty aat Fuzzy / Terms / Exact Label Match
6159
- Wikidata Q Items
60+
- MESH Terms and Descriptors (Starts / Contains / Exact)
61+
- [Local Webform Strawberryfield Custom LoD Endpoints](webform_sbf_custom_lod.md)
6262

6363
To preview the values contained in the column(s) you selected, click the 'Inspect cleaned/split up column values' button.
64-
6564

6665
![AMI LoD](images/ami/AMIreconcileValuePreview.jpg)
6766

@@ -72,9 +71,9 @@ When ready, there are multiple processing options to select from depending on yo
7271
- To process immediately, select 'Process LoD from Source'
7372
- To enqueue the batch process, select 'Enqueue but do not process Batch in real time.
7473
- To add new data (i.e. terms, LoD Authority Sources) to existing reconciliation (e.g after replacing
75-
source CSV data), select 'Re-process only adding new terms/LoD Authority Sources
74+
source CSV data), select 'Re-process only adding new terms/LoD Authority Sources'
7675

77-
![Process LoD](images/processLoD.jpg)
76+
![Process LoD](images/processLoD_1-6-0.png)
7877

7978
*Important note: if you have previously run LoD Reconciliation for your AMI set, this action will overwrite any manually corrected LoD on your Processed CSV. Please make sure you have a backup if unsure.*
8079

@@ -96,7 +95,7 @@ You will see a table (form) containing:
9695
- A Checked option you can use to denote that an LoD mapping has been reviewed/revisioned
9796
- The Linked Data Label and URL pairing selected during the LoD reconciliation process
9897

99-
![AMI Edit Reconciled LoD](images/ami/AMIeditReconciledLoD.jpg)
98+
![AMI Edit Reconciled LoD](images/AMIeditReconciledLoD_1-6-0.png)
10099

101100
The results table will show 10 original terms and mappings per page. You can advance through the pages using the page numbers and navigational arrows above and below the table.
102101

@@ -158,7 +157,16 @@ The same general pattern can be adapted to apply to different mapping scenarios
158157
- 'getty_aat_terms' => Getty aat Terms
159158
- 'getty_aat_exact' => Getty aat Exact Label Match
160159
- 'wikidata_subjects_thing' => Wikidata Q Items
160+
- 'mesh;term;startswith' => 'MeSH (starts with Term)',
161+
- 'mesh;term;contains' => 'MeSH (contains Term)',
162+
- 'mesh;term;exact' => 'MeSH (exact Term)',
163+
- 'mesh;descriptor;startswith' => 'MeSH (starts with Descriptor)',
164+
- 'mesh;descriptor;contains' => 'MeSH (contains Descriptor)',
165+
- 'mesh;descriptor;exact' => 'MeSH (exact Descriptor)'
166+
167+
!!! note "Important note for Webform Strawberryfield Custom LoD Endpoints
161168

169+
When using Archipelago's [Local Webform Strawberryfield Custom LoD Endpoints](webform_sbf_custom_lod.md), the Processed LoD Information details will be generated dynamically, based on the column name of the source local LoD plus the prefix 'custom_'. For example, if your column name was 'local_lod_provider', the Processed LoD contextual information would show `custom_local_lod_provider` as the 'lod_endpoint_type'.
162170

163171
## Next Steps
164172

docs/devops.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ Installation is entirely [Dockerized](https://www.docker.com) and scripted with
2020
--- | --- | ---
2121
esmero-web | NGNIX | Routes calls to esmero-php
2222
esmero-php | PHP-FPM | Has all binaries for postprocessing/exif/ocr/etc. Runs PHP code.
23-
esmero-db | Database | AMD and INTEL processors: MYSQL 8<br />ARM processors: MariaDB
23+
esmero-db | Database | AMD and INTEL processors: MYSQL 8.0.44<br />ARM processors: MariaDB 10.6.24
2424
esmero-minio | Storage | S3 API compatible Backend file and ADO as file storage. In a local it will do all the S3 stuff, on a live instance it can server as file routing to AWS S3, Azure Blob Storage, etc.
25-
esmero-solr | Solr | Currently version 9.8.4
25+
esmero-solr | Solr | Currently version 9.10
2626
esmero-nlp | Natural Language Processing | NLP64 server for entity extraction, language detection, ML, etc.
27-
esmero-cantaloupe | IIIF Media Server| Customized Server used to provide IIIF Image API/Media access
27+
esmero-cantaloupe | IIIF Media Server| Customized Server used to provide IIIF Image API/Media access
2828

2929
* Information related to non-Dockerized installation and configruation can be found here: [Traditional Installation Notes](traditional-install.md)
3030

144 KB
Loading
61.8 KB
Loading
142 KB
Loading

docs/images/AMIrunaction_1-6-0.png

76.3 KB
Loading
174 KB
Loading
141 KB
Loading

0 commit comments

Comments
 (0)