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.

Sign up for GitHub

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

Jump to bottom

Document file viewer logic. #1722

Merged
merged 6 commits into from
Dec 15, 2020
Merged

Document file viewer logic. #1722

merged 6 commits into from
Dec 15, 2020

Conversation

rosiel
Copy link
Member

@rosiel rosiel commented Dec 4, 2020

Purpose / why

To document how to administer an islandora. #1538

Partly the purpose was to highlight how darn complicated this system is, and encourage improvements such as #1193 ;)

Also does a bit to further "documenting display hints" #1222

What changes were made?

Created a page about "Viewers" that explains the chain of things that need to be in place to configure them.
Also did some minor rewording to the resource-nodes page where @mjordan documented "Display hints", which is an amazing how-to guide and I'm sorry I didn't have time to do it justice (e.g. it could really be its own page)

Verification

Please read, try out? open files? poke in islandora defaults?

@seth-shaw-unlv does this match your understanding of the Goldberg Machine To Display A Viewer?

Interested Parties

@Islandora/documentation and those tagged above.

Checklist

Pull-request reviewer should ensure the following

  • Does this PR link to related issues?
  • Does the proposed documentation align with the Islandora Documentation Style Guide?
  • Are the changes accurate, useful, free of typos, etc?
  • Does this PR update the last updated on date on the documentation page?

Person merging should ensure the following

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

@seth-shaw-unlv
Copy link
Contributor

@rosiel, I made a number of comments on different bits. They are all suggestions that you are free to incorporate, alter, or ignore as you see fit. I don't consider any of them to be blockers.

@rosiel
Copy link
Member Author

rosiel commented Dec 4, 2020

Thank you @seth-shaw-unlv for the thorough review!

@seth-shaw-unlv
Copy link
Contributor

Sorry for the delay in reviewing the updates! I was buried in a combination of D9 Sprint and other work items.

@rosiel
Copy link
Member Author

rosiel commented Dec 15, 2020

OK, anyone...?

@seth-shaw-unlv seth-shaw-unlv merged commit 1abd6a3 into Islandora:main Dec 15, 2020
@rosiel rosiel deleted the viewers branch January 4, 2021 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@seth-shaw-unlv seth-shaw-unlv seth-shaw-unlv left review comments

@mjordan mjordan mjordan left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rosiel @seth-shaw-unlv @mjordan