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

fix: image aspect ratio on component preview [FC-0062] [sumac] #35791

Merged
merged 1 commit into from
Nov 8, 2024
Merged

fix: image aspect ratio on component preview [FC-0062] [sumac] #35791

merged 1 commit into from
Nov 8, 2024
+1 −0

Conversation

rpenido
Copy link
Contributor

@rpenido rpenido commented Nov 6, 2024 •
edited
Loading

Backport of #35790

Note that these files where changed on master after this PR:

Description

This PR fixes a bug wherein an image is rendered with the wrong aspect ratio if included in a Text component with explicit width and height.

More Information

Testing instructions

  1. Before checking out this branch, create a new Text block with the following OFX:
<html display_name="Text46">
  <p>Hi!</p>
  <p><img src="https://upload.wikimedia.org/wikipedia/commons/3/3f/Fronalpstock_big.jpg" width="1313" height="590" /></p>
</html>
  1. Check the component preview on the sidebar, and it should look distorted aspect ratio
  2. Checkout this branch
  3. Run tutor dev exec cms openedx-assets build --env=dev to rebuild the css
  4. Reload the page, and the image should look with the correct aspect ratio

Note

If you face the following error while running the sumac branch on an updated tutor stack,

cms-1               | django.db.utils.OperationalError: (1054, "Unknown column 'content_libraries_contentlibrary.type' in 'where clause'")

you should need to rollback a single migration to fix it:

tutor dev exec cms python manage.py cms migrate content_libraries 0010_contentlibrary_learning_package_and_more

Private ref: FAL-3926

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 6, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @rpenido!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@rpenido rpenido added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Nov 6, 2024
@rpenido rpenido force-pushed the rpenido/sumac/fal-3926-fix-image-aspect-ratio-on-preview branch from 4ab4c46 to 2472a93 Compare November 7, 2024 09:24
@rpenido rpenido added the FC Relates to an Axim Funded Contribution project label Nov 7, 2024
navinkarkera
navinkarkera approved these changes Nov 7, 2024
View reviewed changes
Copy link
Contributor

@navinkarkera navinkarkera left a comment

Choose a reason for hiding this comment

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

@rpenido 👍 Looks good.

  • I tested this: (verified image preview with fixed height)
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

you should need to rollback a single migration to fix it:

Just a nit in instructions: we need to checkout master before running the migration command

pomegranited
pomegranited approved these changes Nov 8, 2024
View reviewed changes
Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

👍 Works in sumac, thank you @rpenido !

  • I tested this on my tutor sumac devstack using the PR test instructions
  • I read through the code
  • I checked for accessibility issues N/A
  • Includes documentation N/A
  • User-facing strings are extracted for translation N/A

@navinkarkera navinkarkera merged commit 2e95777 into openedx:open-release/sumac.master Nov 8, 2024
48 checks passed
@navinkarkera navinkarkera deleted the rpenido/sumac/fal-3926-fix-image-aspect-ratio-on-preview branch November 8, 2024 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@navinkarkera navinkarkera navinkarkera approved these changes

@pomegranited pomegranited pomegranited approved these changes

Assignees
No one assigned
Labels
create-sandbox open-craft-grove should create a sandbox environment from this PR FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rpenido @openedx-webhooks @pomegranited @navinkarkera