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

Summary #1334

Merged
merged 3 commits into from
Nov 18, 2019
Merged

Summary #1334

merged 3 commits into from
Nov 18, 2019

Conversation

qadan
Copy link

@qadan qadan commented Nov 13, 2019

GitHub Issue: #1040

What does this Pull Request do?

Expands the summary page of the documentation, and, ideally, makes it a better and more accurate representation of the goals and key features of Islandora 8

What's new?

A lot of the words have been:

  • added
  • changed
  • removed (not really that much tho; I tried as much as possible to maintain the spirit of the 1.0 summary page while moving the actual words inside it to sensible locations)

How should this be tested?

If you really feel like it, build and deploy as usual using mkdocs to follow along locally. Otherwise just read the markdown and make sure it's not inaccurate or bad or any of that kind of thing

@qadan
Copy link
Author

qadan commented Nov 13, 2019

i am realizing now on re-read that the summary basically says that 'out of the box' islandora 8 includes 'a community' which i think is kind of funny and i'm leaving it there

Copy link
Contributor

@dannylamb dannylamb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All in all this looks pretty good. Better than what we had for sure. Just a few small things.

docs/index.md Outdated
and pushed into a Fedora repository. It also allows you to connect repository content with microservices, small webapps that transform files to other types for display or preservation, or to extract additional metadata.
- A suite of customized Drupal resource types and configurations, packaged as the [Islandora 8 Drupal module](https://github.com/Islandora/islandora), that streamline the process of creating digital preservation resources natively within Drupal as nodes, media, files, and taxonomy terms
- Complete integration between Drupal resources and Duraspace's [Fedora 5.x Repository](https://wiki.duraspace.org/display/FF/Fedora+Repository+Home), including RDF conversion and asset storage
- The [Crayfish](https://github.com/Islandora/crayfish) suite of microservices that provides resource mapping to Fedora and automated generation of derivative images and OCR, and which can be extended to provide even more services
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also generate video and audio, too. Maybe just say automated generation of derivative files instead?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, forgot about that; will add

docs/index.md Outdated
- A suite of customized Drupal resource types and configurations, packaged as the [Islandora 8 Drupal module](https://github.com/Islandora/islandora), that streamline the process of creating digital preservation resources natively within Drupal as nodes, media, files, and taxonomy terms
- Complete integration between Drupal resources and Duraspace's [Fedora 5.x Repository](https://wiki.duraspace.org/display/FF/Fedora+Repository+Home), including RDF conversion and asset storage
- The [Crayfish](https://github.com/Islandora/crayfish) suite of microservices that provides resource mapping to Fedora and automated generation of derivative images and OCR, and which can be extended to provide even more services
- The [Alpaca](https://github.com/Islandora/Alpaca) suite of middleware services that ensure Crayfish's resource mapping and derivative generation are capable of scaling
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alpaca's main role is to invoke microservices in the background. I'm not sure how best to embellish that language, but that's the main point I'd try to convey.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that makes more sense. making this as well

docs/index.md Outdated

Islandora 8 allows you to create nodes, media, files, and taxonomy terms in Drupal, which are converted to RDF
and pushed into a Fedora repository. It also allows you to connect repository content with microservices, small webapps that transform files to other types for display or preservation, or to extract additional metadata.
- A suite of customized Drupal resource types and configurations, packaged as the [Islandora 8 Drupal module](https://github.com/Islandora/islandora), that streamline the process of creating digital preservation resources natively within Drupal as nodes, media, files, and taxonomy terms
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should be saying "creating digital preservation resources", since that might suggest that the process of preservation is set-and-forget. I'd much rather see "creating preservable digital resources". It's hair splitting but I think it's an important distinction.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely can make that change 👍

- A [batch import/migration framework](https://github.com/Islandora/migrate_islandora_csv) to serve as a launching point to get your preservation content into Islandora 8
- Other important preservation and discovery pieces, such as [JSON-LD serialization](https://github.com/Islandora/jsonld) for linked data discoverability, [controlled access terms](https://github.com/Islandora/controlled_access_terms) for subjects and agents, and a [full configuration for exposing OAI-PMH](https://github.com/Islandora/islandora_defaults/tree/8.x-1.x/modules/islandora_oaipmh) to metadata harvesters
- A [dedicated, active community](https://groups.google.com/forum/#!forum/islandora) working to push new features, collaborate on improvements, and design custom solutions

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be worth including mention of the new IIIF support, and maybe Openseadragon/Mirador as viewer options?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at this I think it's a brainful to jam preservation and discovery together, so will separate out so that IIIF/Openseadragon stuff can be added

@dannylamb
Copy link
Contributor

I'm good with all this. Everyone else happy?

@manez
Copy link
Member

manez commented Nov 18, 2019

All good here!

@dannylamb dannylamb merged commit 1bf9abe into Islandora:master Nov 18, 2019
@dannylamb
Copy link
Contributor

@qadan 's made the change @mjordan requested, so I'm just gonna hit 'dat merge button.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants