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

Documentation: update the github wiki to include guidance for embedding images, images with alignment, and youtube videos #684

Open
jhung opened this issue Aug 15, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jhung
Copy link
Member

jhung commented Aug 15, 2023

The IDRC website wiki should be updated to include how an author can add different media types. Specifically:

  • add image
  • image position with text
  • YouTube embed
  • File

image

Note: these features are only available in some and not all editors. For example they're available in Page and Project Body editors, and not Page Intro or Project Listing Description editors.

@jhung jhung added the enhancement New feature or request label Aug 15, 2023
@jhung
Copy link
Member Author

jhung commented Aug 15, 2023

In the documentation, it may also be worth mentioning copying the YouTube embed code from the YouTube site will make the video not scale well on the website. Therefore embedding YouTube videos should be done with our helper.

Quote from @greatislander in response to a support question:

By default if you copy an embed code from YouTube, it includes a hard-coded width of (I believe) 560 pixels. That causes all of the content to overflow on small device screens and messes up the image sizing (which is styled so as to not exceed the container width… but if the device width is 320 pixels, for example, and the container is larger than that, it will appear too large).

We anticipated this issue with embedded video and there is a helper for adding embedded YouTube videos that will prevent them from overflowing on small sizes. When authoring content on the site, choose “YouTube Embed” from the toolbar menu...

@jhung jhung self-assigned this Sep 5, 2023
@jhung jhung added the documentation Improvements or additions to documentation label Sep 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant