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

[TECH DEBT] Break out Mirador into a separate module #2163

Closed
rosiel opened this issue Sep 8, 2022 · 10 comments
Closed

[TECH DEBT] Break out Mirador into a separate module #2163

rosiel opened this issue Sep 8, 2022 · 10 comments
Labels
Type: feature request a proposal for a new feature in the software (should be justified by a ‘use case’)

Comments

@rosiel
Copy link
Member

rosiel commented Sep 8, 2022

Overview of feature request

Mirador functionality is currently bundled in a submodule of Defaults. But there is no reason the code shouldn't be a standalone viewer module like OpenSeadragon.

The only thing that would have to be moved are the configs under config/install that are not setting default values for the options provided for this module itself (contexts, entity view displays, etc) which can go in the Starter Site.

What kind of user is the feature intended for?

Anyone running an islandora site who wants to be able to use Mirador (which can, in theory, do text overlay)
Anyone who wants to be able to run Mirador in Drupal outside of islandora

What existing behavior do you want changed?

Not behaviour but code task - the location of the mirador module .

Any brand new behavior do you want to add to Islandora?

in relation to this, it would be cool to provide instructions to upgrade in case you've already installed Mirador.

Any related open or closed issues to this feature request?

@rosiel rosiel added the Type: feature request a proposal for a new feature in the software (should be justified by a ‘use case’) label Sep 8, 2022
@alxp
Copy link
Contributor

alxp commented Sep 15, 2022

I've added LICENSE and README files to https://github.com/alxp/islandora_mirador. It should be good to move to Islandora organization.

@inikolaidis is there any updated boilerplate I should also add?

@inikolaidis
Copy link
Contributor

@alxp Small changes made to the README in this PR: https://github.com/alxp/islandora_mirador/pull/1

@alxp
Copy link
Contributor

alxp commented Sep 20, 2022

@inikolaidis Thanks! Merged in to my islandora_mirador instance.

@rosiel
Copy link
Member Author

rosiel commented Sep 21, 2022

Our LSAP (currently being reworked and I dont know of a public facing document - ping @islandora-community), to be accepted by the Foundation as a module, it should have tests and a Github Workflows integration that runs them (as well as code sniffer and codecov).

I also would like to strip out the Feature module that contains configuration specific to islandora, and include it in the Islandora Starter Site. The starter site is now 'launched' though has no versions yet.

@alxp
Copy link
Contributor

alxp commented Sep 21, 2022

Tests are a good idea but since the code itself is already in the Islandora project, just under islandora_defaults, I don't think the LSAP applies in this case so perhaps it's not necessarily a blocker. I will look in to making a test regardless.

@rosiel
Copy link
Member Author

rosiel commented Sep 21, 2022

Making this available for everyone to improve sounds like the best plan. The repo has been transferred and is at
https://github.com/Islandora/islandora_mirador

Do not close until documentation repo is updated.

@rosiel
Copy link
Member Author

rosiel commented Sep 21, 2022

Repo needs to be registered with Packagist.
Need to roll a release of Islandora Defaults that doesn't include Mirador.

@alxp
Copy link
Contributor

alxp commented Sep 21, 2022

PR for islandora_defaults without Mirador:

Islandora/islandora_defaults#75

@rosiel
Copy link
Member Author

rosiel commented Nov 3, 2022

The PR has been merged. 🎉

@rosiel rosiel closed this as completed Nov 3, 2022
@rosiel
Copy link
Member Author

rosiel commented Nov 3, 2022

Do not close until documentation repo is updated.

Oops. 😳

@rosiel rosiel reopened this Nov 3, 2022
@rosiel rosiel closed this as completed Dec 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: feature request a proposal for a new feature in the software (should be justified by a ‘use case’)
Projects
None yet
Development

No branches or pull requests

3 participants