Documentation New Guides & Updates for 1.4.0 - Round 1 #200

alliomeria · 2024-06-18T15:27:45Z

New Guides:

wacz_page_extractor and webpage post-processor
warc_to_wacz post-processor
subtitle post-processor
IIIF Server Configuration Forms
IIIF Content Search API
Core Documentation Guides

Updates for:

a bunch of things & more incoming (screenshots, lists, see also Update default options listed in different docs #199)
mkdocs.yml navigation structure

- update text + image to reference new subtitle SBR

Line spacing

Add note for VBO processor for Facets

Few more wording updates

Still need to update the roadmap :)

Still need to update (or remove the default View Mode mappings--since that is one of the first things people change in any case!)

DiegoPino

@alliomeria this is really good stuff!! I left a few comments around (mostly comments/ideas/some give or take..) and a note about OCR settings/pager settings on the subtitle one that do not apply I think, might be just left overs of a previous copy. Please feel free to tackle (if) my comments after the Holiday. Thanks so much for your work! 🥇

docs/101_guides_list.md

DiegoPino · 2024-06-18T18:19:25Z

docs/find_and_replace.md

+
+!!! warning "Adding New Facets"
+
+    The default Facets available through Archipelago's Advanced Batch Find and Replace have an important configuration selection made on each individual Facet. For every [new Facet you add](strawberry_key_name_providers.md) for Find and Replace, you need to select the checkboxes for both the 'VBO batch handler' settings to use the `VBO Batch Facet processor`, and the selection within the 'VBO batch handler settings' to `Use URL based facets in VBO Batches`. You need to make sure these are selected so that the "visible" list/count of objects you filter using a Facet is respected during actual VBO process execution of batch changes you make for any Find and Replace Actions.


Ok! Here is a missing need/documentation part that needs to be added. VBO does not pass a "limit" (except if your VIEW has actually a "SHOW" a defined number of results which most users will never use. Because of that, when run will default to the Search API/Solr defined Limit. At
http://localhost:8001/admin/config/search/search-api/server/esmero_solr/edit (under the advanced tab). Which means if you see 1000 objects In your Find and Replace and select all and run IT and that value here is 100, only 100 will be processed. Nothing we can do around that (for now, except open an ISSUE, tag me, maybe we can find a way). We need a note for that 🐝 !

Ok, added an additional statement about this behavior, using some of the language you shared in your above comment. Let me know what think @DiegoPino

docs/iiif-content-search.md

docs/iiif_server_settings.md

docs/index.md

docs/strawberryrunners_subtitle.md

docs/webformsasinput.md

per Diego Co-authored-by: Diego Pino Navarro <[email protected]>

Co-authored-by: Diego Pino Navarro <[email protected]>

Add 'service' snippet

Add more notes about VBO limits

alliomeria · 2024-06-18T20:00:41Z

Thanks for your review and feedback @DiegoPino! I incorporated some small changes based on your comments, resolved most comments, and left a couple for you re: VBO limit note and IIIF Config Form Snippet example (I did the 'service' snippet to the IIIF Content Search API doc as recommended). Please let me know what you think and if/when I'm clear to merge this batch of new and updates docs. 🤓

docs/iiif_server_settings.md

DiegoPino · 2024-06-18T20:07:03Z

@alliomeria you totally free to merge. We have not yet enabled the automatic Github pages trigger for 1.4.0 so we have a few days more of slack in case you find anything you want to change. All looks good/awesome to me. I might need fresher eyes though to re-read all the extra things you added and add emojis here and there. Thanks again for your hard work on these.

alliomeria · 2024-06-18T20:09:39Z

Ok great, I will merge in just a few moments. Yes, we don't yet have the 1.4.0 public docs site syncing setup just yet. No worries, that's on my Friday tasks to setup and push a test for. :)

DiegoPino · 2024-06-18T20:12:01Z

Woho!

Merge pull request esmero#200 from alliomeria/1.4.0

alliomeria added 25 commits May 3, 2024 15:46

May 2024 Docs Images Part 1

1204c97

Updated SBR home image

cdda1f8

Update strawberryrunners.md

2860512

- update text + image to reference new subtitle SBR

New SBR Subtitle + IIIF Server Settings docs

f837730

Update strawberryrunners_pager_ocr.md

d2a6830

Line spacing

Update strawberryrunners_webpage_text.md

beeea1e

Update strawberryrunners_webpage_text.md

66b9132

Update strawberryrunners_wacz_binary.md

bf60ff5

Update find_and_replace.md

babc48b

Add note for VBO processor for Facets

Update find_and_replace.md

538a27a

Few more wording updates

Update iiif_server_settings.md

9313e8d

IIIF Content Search Overview

4301bcc

Update iiif-content-search.md

7a15d95

Update index.md

3619737

Still need to update the roadmap :)

Update inthewild.md

fa15c3b

Update strawberryfield-formatters.md

59f0dde

Still need to update (or remove the default View Mode mappings--since that is one of the first things people change in any case!)

Update webformsasinput.md

7d3a14c

Update mkdocs.yml

6c4c534

Update mkdocs.yml

3c08f7b

Create 101_guides_list.md

db6e80a

Update 101_guides_list.md

5877067

Update 101_guides_list.md

4ec8281

Update 101_guides_list.md

b49125e

Update 101_guides_list.md

87ca45d

Update mkdocs.yml

9761b05

alliomeria added documentation Improvements or additions to documentation enhancement New feature or request Release Duties Release and Github cleanups labels Jun 18, 2024

alliomeria added this to the 1.4.0 milestone Jun 18, 2024

alliomeria requested a review from DiegoPino June 18, 2024 15:27

alliomeria added 13 commits June 18, 2024 12:33

Update webformsasinput.md

7ccdc25

Add files via upload

79097f0

Update webformsasinput.md

42332b5

Add files via upload

abb3806

Rename displays-modes-2024.png to display-modes-2024.png

3412a8b

Update webformsasinput.md

9fb8cf3

more updated images

ba9bf83

Update webformsasinput.md

a84e644

Update strawberryfield-formatters.md

0aea479

Add files via upload

af55ccf

Update webformsasinput.md

a5fe454

Update inthewild.md

f3dd288

Update mkdocs.yml

c9ebaf0

DiegoPino reviewed Jun 18, 2024

View reviewed changes

alliomeria and others added 6 commits June 18, 2024 15:30

Update docs/iiif-content-search.md

ca47108

per Diego Co-authored-by: Diego Pino Navarro <[email protected]>

Update strawberryrunners_subtitle.md

5f9ce65

Update end of strawberryrunners_subtitle.md

88b0842

Update docs/webformsasinput.md

49eba8c

Co-authored-by: Diego Pino Navarro <[email protected]>

Update iiif-content-search.md

759d3eb

Add 'service' snippet

Update find_and_replace.md

68625b3

Add more notes about VBO limits

Update iiif_server_settings.md

164ba16

alliomeria commented Jun 18, 2024

View reviewed changes

docs/iiif_server_settings.md Outdated Show resolved Hide resolved

Update iiif_server_settings.md

86835e6

alliomeria merged commit 3481c68 into esmero:1.4.0 Jun 18, 2024

alliomeria changed the title ~~Documentation New Guides & Updates for 1.4.0~~ Documentation New Guides & Updates for 1.4.0 - Round 1 Jun 18, 2024

alliomeria added a commit to alliomeria/archipelago-documentation that referenced this pull request Jun 18, 2024

Merge pull request #9 from esmero/1.4.0 ->sync my local with the main

434a341

Merge pull request esmero#200 from alliomeria/1.4.0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation New Guides & Updates for 1.4.0 - Round 1 #200

Documentation New Guides & Updates for 1.4.0 - Round 1 #200

alliomeria commented Jun 18, 2024 •

edited

Loading

DiegoPino left a comment

DiegoPino Jun 18, 2024

alliomeria Jun 18, 2024

alliomeria commented Jun 18, 2024

DiegoPino commented Jun 18, 2024

alliomeria commented Jun 18, 2024

DiegoPino commented Jun 18, 2024


		!!! warning "Adding New Facets"

		The default Facets available through Archipelago's Advanced Batch Find and Replace have an important configuration selection made on each individual Facet. For every [new Facet you add](strawberry_key_name_providers.md) for Find and Replace, you need to select the checkboxes for both the 'VBO batch handler' settings to use the `VBO Batch Facet processor`, and the selection within the 'VBO batch handler settings' to `Use URL based facets in VBO Batches`. You need to make sure these are selected so that the "visible" list/count of objects you filter using a Facet is respected during actual VBO process execution of batch changes you make for any Find and Replace Actions.

Documentation New Guides & Updates for 1.4.0 - Round 1 #200

Documentation New Guides & Updates for 1.4.0 - Round 1 #200

Conversation

alliomeria commented Jun 18, 2024 • edited Loading

DiegoPino left a comment

Choose a reason for hiding this comment

DiegoPino Jun 18, 2024

Choose a reason for hiding this comment

alliomeria Jun 18, 2024

Choose a reason for hiding this comment

alliomeria commented Jun 18, 2024

DiegoPino commented Jun 18, 2024

alliomeria commented Jun 18, 2024

DiegoPino commented Jun 18, 2024

alliomeria commented Jun 18, 2024 •

edited

Loading