Skip to content

Conversation

@bondjimbond
Copy link
Contributor

Document the process for using remotely-hosted media in Islandora, including instructions for embed code and oEmbed providers.

Replaces this Islandora Cookbook PR as I understand that the Cookbook is being deprecated/merged into this documentation(?).

What changes were made?

New "recipe" for handling remote media.

Verification

Follow the steps and test.

Interested Parties

@aOelschlager
@Islandora/documentation
@Islandora/committers

Checklist

Pull-request Reviewer

Pull-request reviewer should ensure the following:

Person Merging

The 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?

Document the process for using remotely-hosted media in Islandora, including instructions for embed code and oEmbed providers.

Replaces [this Islandora Cookbook PR](https://github.com/Islandora-Labs/Islandora-Cookbook) as I understand that the Cookbook is being deprecated/merged into this documentation(?).
@github-actions
Copy link

PR Preview Action v1.6.3

🚀 View preview at
https://Islandora.github.io/documentation/pr-preview/pr-2380/

Built to branch gh-pages at 2025-11-21 15:01 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@bondjimbond
Copy link
Contributor Author

@aOelschlager I'm not sure where in the menu tree in mkdocs.yml this should go.

@ysuarez
Copy link
Contributor

ysuarez commented Dec 4, 2025

@bondjimbond apologies for the wait.

You can keep the new doc file in your suggested path of:
docs/user-documentation/recipes/remote-media.md

Now we should come up with a link from the table of contents (TOC) in the mkdocs.yml file as part of the extending Osladnora section.

https://github.com/Islandora/documentation/blob/d6ef5ab455818bcd1db042c4ae45724da6a7cbd9/mkdocs.yml#L245C1-L249C101

Perhaps a change like this...

      - 'Extending Islandora':
          - 'Extending': 'user-documentation/extending.md'
          # conceptual, repository managers/ developers
          - 'Recipes':
              - 'Automatically Minting DOIs with DataCite': 'user-documentation/recipes/datacite.md'
              - 'Remotely-hosted Media in Islandora': 'user-documentation/recipes/remote-media.md'

Would you like me to make this change after we merge this PR, or would you like to add it yourself?

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.

3 participants