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

Update and clarify README for 7.x-1.13 #100

Merged
merged 1 commit into from
Aug 21, 2019
Merged

Update and clarify README for 7.x-1.13 #100

merged 1 commit into from
Aug 21, 2019

Conversation

bencomp
Copy link

@bencomp bencomp commented Aug 13, 2019

JIRA Ticket: n/a

What does this Pull Request do?

This update does not present new information, but hopefully makes the README more accessible.

  • add "Djatoka or IIIF image server" as requirement
  • reorder installation options, implicitly prefer Drush
  • explain what configuration is discussed here
  • explain IIIF settings
  • align IIIF settings with Djatoka settings
  • make reverse proxy information more generic
  • remove Apache example setup
  • update Cantaloupe URLs
  • use more informative link labels
  • fix a few typos

What's new?

Of the above listed changes, I consider these new-ish:

  • add "Djatoka or IIIF image server" as requirement
  • explain what configuration is discussed here
  • explain IIIF settings
  • align IIIF settings with Djatoka settings
  • make reverse proxy information more generic
  • remove Apache example setup
  • update Cantaloupe URLs
  • use more informative link labels

How should this be tested?

Please read.

Additional Notes:

I haven't touched the wiki page yet.

Interested parties

@DiegoPino, @DonRichards and @Islandora/7-x-1-x-committers

This update does not present new information, but hopefully makes the
README more readable.

- add "Djatoka or IIIF image server" as requirement
- reorder installation options, implicitly prefer Drush
- explain what configuration is discussed here
- explain IIIF settings
- align IIIF settings with Djatoka settings
- make reverse proxy information more generic
- remove Apache example setup
- update Cantaloupe URLs
- use more informative link labels
- fix a few typos
@manez
Copy link
Member

manez commented Aug 16, 2019

@bencomp can you make a PR on the main branch as well, so this gets into future releases?

Copy link

@DiegoPino DiegoPino left a comment

Choose a reason for hiding this comment

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

Will wait for the 7.x equivalent pull and merge both. Nice work on the docs @bencomp !

@whikloj
Copy link
Member

whikloj commented Aug 19, 2019

@bencomp <bump>

@whikloj
Copy link
Member

whikloj commented Aug 21, 2019

@DiegoPino if you want to merge this, I can make the PR for 7.x using this commit.

@bencomp
Copy link
Author

bencomp commented Aug 21, 2019

@whikloj I'm happy to make the commit myself, but I was out of town for a few days and have not had time yet. I can do it tonight.

@DiegoPino DiegoPino merged commit aa36a77 into Islandora:7.x-1.13 Aug 21, 2019
@whikloj
Copy link
Member

whikloj commented Aug 21, 2019

@bencomp if you can open the PR on 7.x that would be great. You can also mark your documentation work on this module as "Done" 🎉

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