Skip to content

feat: preserve image alt text while converting html to text - #36333

Merged
ChrisChV merged 4 commits into
openedx:masterfrom
open-craft:navin/fal-4092/preserve-alt-text
Mar 6, 2025
Merged

feat: preserve image alt text while converting html to text#36333
ChrisChV merged 4 commits into
openedx:masterfrom
open-craft:navin/fal-4092/preserve-alt-text

Conversation

@navinkarkera

@navinkarkera navinkarkera commented Mar 6, 2025

Copy link
Copy Markdown
Contributor

Description

Replace image with its alt text while converting html to plain text for indexing.

Useful information to include:

  • Which edX user roles will this change impact? Common user roles are "Learner", "Course Author", and "Developer".

image

Supporting information

Testing instructions

  • Create or edit any html component with image and alt text in library and save it (to reindex it)
  • Verify that the card preview shows the alt text in place of the image.

@openedx-webhooks

openedx-webhooks commented Mar 6, 2025

Copy link
Copy Markdown

Thanks for the pull request, @navinkarkera!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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.

Details
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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 6, 2025
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Mar 6, 2025
@navinkarkera
navinkarkera marked this pull request as ready for review March 6, 2025 06:39
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Mar 6, 2025
@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Mar 6, 2025

@rpenido rpenido left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 👍
Thank you for your work, @navinkarkera!

  • I tested this using the instructions from the PR
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

@ChrisChV
ChrisChV enabled auto-merge (squash) March 6, 2025 16:30
@ChrisChV
ChrisChV merged commit 2613c8e into openedx:master Mar 6, 2025
@ChrisChV
ChrisChV deleted the navin/fal-4092/preserve-alt-text branch March 6, 2025 16:55
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Mar 6, 2025
@openedx-webhooks openedx-webhooks removed the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Mar 6, 2025
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

tonybusa pushed a commit to tonybusa/edx-platform that referenced this pull request Apr 23, 2025
…36333)

Replace image with its alt text while converting html to plain text for indexing.
UsamaSadiq pushed a commit that referenced this pull request May 14, 2025
Replace image with its alt text while converting html to plain text for indexing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

6 participants