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

Iiif docs #1355

Merged
merged 9 commits into from
Nov 25, 2019
Merged

Iiif docs #1355

merged 9 commits into from
Nov 25, 2019

Conversation

mjordan
Copy link
Contributor

@mjordan mjordan commented Nov 20, 2019

GitHub Issue: Maybe #1184 ?

What does this Pull Request do?

Adds a page to the User Documentation describing how IIIF is implemented in Islandora 8. View it live at https://github.com/mjordan/documentation/blob/iiif_docs/docs/user-documentation/iiif.md.

What's new?

Adds a single new page (docs/user-documentation/iiif.md) and one image (docs/assets/osd_collection_mode.png).

How should this be tested?

Same as other documentation: read, suggest, correct, etc.

Question: how much of this should be documented as "Paged content"? @seth-shaw-unlv's #1333 is currently under review so we should make sure there is no overlap, or that the two pages link to each other where appropriate.

Additional Notes:

Currently, what is described in this page does not work. See #1294 for more info.

Interested parties

@cderven @Islandora/8-x-committers

@mjordan mjordan requested a review from cderven November 20, 2019 16:03
@seth-shaw-unlv
Copy link
Contributor

seth-shaw-unlv commented Nov 20, 2019

I haven't been able to reproduce @Natkeeran's issue that you referenced in the PR description and it has been working fine for me. I did it recently to make screenshots for the Doc Sprint. So, yeah, it is generally working. (I suspect it was a bad derivative.)

As to the overlap, a very brief scan of this PR shows only a tiny bit of repetition, which is fine. Although, I should probably update mine to reference the IIIF documentation. Update: added said reference.

Copy link
Member

@manez manez left a comment

Choose a reason for hiding this comment

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

Only the typo is a true requested change.

docs/user-documentation/iiif.md Outdated Show resolved Hide resolved
docs/user-documentation/iiif.md Show resolved Hide resolved
docs/user-documentation/iiif.md Outdated Show resolved Hide resolved
docs/user-documentation/iiif.md Show resolved Hide resolved
docs/user-documentation/iiif.md Show resolved Hide resolved
docs/user-documentation/iiif.md Outdated Show resolved Hide resolved
@cderven
Copy link

cderven commented Nov 22, 2019

I don't there's any direct overlap here with paged content and I don't think anything needs to be moved to paged content.

@mjordan
Copy link
Contributor Author

mjordan commented Nov 24, 2019

@manez I've lost track of where the remaining typo is - can you clarify?

@manez
Copy link
Member

manez commented Nov 25, 2019

@mjordan you got it already! It's all good now 😄

Edit: I thought I had just left a comment, not requested changes. Cleared that now too.

@dannylamb dannylamb merged commit edd9b4f into Islandora:master Nov 25, 2019
whikloj pushed a commit that referenced this pull request Dec 3, 2019
* update objects and media

doc sprint

* add paged content

* fix image link and note formatting

* separate paged content to a new file

* remove two lines missed in previous commit

* update toc and rename objects.md to resource-nodes.md

* move re-order page screenshot after descriptive text

* update collections.md

* remove superceded note

* clarify node properties and add screenshots

* add link to REST documentation

* clarifying Islandora collection behavior based on rosiel's feedback

* add more description about using the paginated OpenSeadragon for paged content

* add reference to forthcoming IIIF documentation in PR #1355

* clarify technical metadata in Islandora 7

* grammar

* update collections screenshots

* update link
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.

5 participants