Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Updates (Macro) #95

Open
14 of 18 tasks
alliomeria opened this issue Dec 16, 2021 · 4 comments · Fixed by #139, #140, #142, #143 or #158
Open
14 of 18 tasks

Documentation Updates (Macro) #95

alliomeria opened this issue Dec 16, 2021 · 4 comments · Fixed by #139, #140, #142, #143 or #158
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@alliomeria
Copy link
Contributor

alliomeria commented Dec 16, 2021

What?

One documentation issue to rule them all! 🧙

This issue is intended to cover new pieces of documentation that are needed and any existing docs in need of updates/changes.

New Pieces of Documentation Needed:

  • Metadata in Archipelago overview
  • Strawberry 🍓 Key Name Providers (see Add full KeyName Provider Documentation Section #65)
  • Find/Search and Replace (all options)
  • Export via CSV (all options)
  • Embargoes: setup and examples
  • Metadata Display Preview & Editing
  • Each formatter with its options (can enumerate)
  • Archipelago Provided Permissions
  • Default Views provided
  • Archipelago generated JSON keys (as:image, ap:tasks, etc)
  • Guide for devops/bash scripts

Existing Documentation in Need of Updating:

  • Update AMI instructions for latest release
    • Main AMI docs page
    • Ingesting via Spreadsheets/Google Sheets
    • I7 Importer
    • LoD Reconciliation: workflow and examples (+ additional information from recent slack discussions?)
  • Review Google API instructions, update any areas needed
  • Creating your First Digital Object: review screenshots and steps; update any areas needed to match latest release

See anything missing from this list? Any recommendations? Offers to contribute your wisdom?

Please feel free to comment on this issue, share documentation requests/ideas, and connect with Archipelago's team and community to learn how to contribute to documentation. 🙏 Many thanks everyone!

@alliomeria alliomeria added the documentation Improvements or additions to documentation label Dec 16, 2021
@DiegoPino
Copy link
Member

I would also suggest @alliomeria we document

  • Each formatter with its options (can enumerate)
  • Archipelago Provided Permissions
  • Views we provide

What do you think @esmero/archipelago-core

@alliomeria
Copy link
Contributor Author

Thanks @DiegoPino! Updated the list above. :)

@alliomeria
Copy link
Contributor Author

alliomeria commented Nov 29, 2022

Checking off some updates and new additions for the AMI documentation (general, ingesting via spreadsheets, spreadsheet formatting + new Metadata in Archipelago document by @DiegoPino ; I7 Solr Importer ) + Guide for devops/bash scripts. Go docs-team go! 👾

Stay tuned 📻 for what's coming up next in the hopper 🐰 : new Metadata Display Preview doc; updates to LoD Reconciliation doc

@DiegoPino
Copy link
Member

Checked a few more thanks to your work @alliomeria, @karomabiles and @aksm !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment