docs: update PDF embed instructions by Kelketek · Pull Request #1432 · openedx/docs.openedx.org

Kelketek · 2026-04-20T19:39:53Z

Description

This PR updates the PDF block creation instructions to reflect the revised interface that will be landing alongside the block in Verawood.

Supporting information

openedx/frontend-app-authoring#2916
Internal ticket: https://tasks.opencraft.com/browse/BB-10743

Testing instructions

Follow the setup instructions here to build and serve the documentation. Verify that the page works and looks right. You should find it here:

http://127.0.0.1:8000/educators/how-tos/course_development/exercise_tools/add_embedded_pdf.html

Rendered doc

https://docsopenedxorg--1432.org.readthedocs.build/en/1432/educators/how-tos/course_development/exercise_tools/add_embedded_pdf.html

openedx-webhooks · 2026-04-20T19:39:59Z

Thanks for the pull request, @Kelketek!

This repository is currently maintained by @openedx/wg-maintenance-docs.openedx.org.

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.

samuelallan72

@Kelketek 👍

Please also add a link to the jira ticket to the PR description.

I tested this: followed the test instructions
I read through the code
I checked for accessibility issues
Includes documentation

samuelallan72 · 2026-04-21T00:30:01Z


-#. In the **Name** field, enter the name for the new component. This will be
-   displayed above the component as a title.
+   You may optionally specify a specific URL for your PDF by selecting


Just a small nit, but there is a variant of specify 3 times in this sentence; dropping one feels less of a tongue twister. ;)

Suggested change

You may optionally specify a specific URL for your PDF by selecting

You may optionally specify a URL for your PDF by selecting

Kelketek · 2026-04-21T14:43:29Z

@sarina Since you reviewed the initial version, would you be up for reviewing this update now that the UI has been updated?

sarina

Could you also update the image in the top of the doc (and remove the old file)?

sarina · 2026-04-21T18:40:22Z

-   The new component is added to the unit with a default example PDF embedded.
+   .. image:: /_images/educator_references/pdf_editor.png
+     :alt: The PDF embed component in Studio.
+     :width: 400


This width makes it super tiny in the rendered doc, I bet you could just remove this entirely because the source image is pretty small.

sarina · 2026-04-21T18:40:57Z

+     :alt: The PDF embed component in Studio.
+     :width: 400

-   .. image:: /_images/educator_references/pdf_embed.png


Can you please delete this outdated image as part of this PR?

This image isn't out of date-- only the authoring interface has changed, so the image at the top of the article is still good, and refers to the same file.

Kelketek · 2026-04-21T19:33:41Z

@sarina I've addressed one note and responded to another. Please take another look. Thanks!

sarina · 2026-04-21T20:10:12Z

Thanks, could you ping me when all my comments are addressed?

Kelketek · 2026-04-21T20:13:51Z

@sarina As far as I can tell, all of your notes are addressed. You asked for me to remove the width constraint on one of the images, which I have done. And you asked for me to remove an image, but that image is not out of date as it is of the unchanged learner interface, and so I do not want to remove it. The image was previously used twice in the article, and now is only used once at the top. Was there anything else you needed?

sarina

Sorry @Kelketek I had pending comments I didn't realize my bad!

sarina · 2026-04-21T18:44:04Z


-   The new component is added to the unit with a default example PDF embedded.
+   .. image:: /_images/educator_references/pdf_editor.png
+     :alt: The PDF embed component in Studio.


This alt text isn't very descriptive. With alt text, you should convey what is being visually represented so that a screenreader user can understand why you're including this image at all. Sometimes this ends up being pretty long and that's okay!

Eg, "The PDF embed component in Studio modal dialogue has a field to provide a file upload. It has a checkbox to show the PDF download link, and optional fields to provide the source document, as explained in the following steps in this tutorial"

Added your description, since it looked good to me.

sarina · 2026-04-21T18:44:22Z

+   the PDF embed block.

-   The new component is added to the unit with a default example PDF embedded.
+   .. image:: /_images/educator_references/pdf_editor.png


Nit: this file should be in educator_how-tos folder not educator_references

Done. I've moved the other image as well.

sarina

Great, sorry about the confusion and thanks for the changes!

Kelketek · 2026-04-21T22:35:15Z

@sarina The CI choked-- can you restart it? Thanks!

openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Apr 20, 2026

Kelketek requested a review from samuelallan72 April 20, 2026 19:39

openedx-webhooks added this to Contributions Apr 20, 2026

github-project-automation Bot moved this to Needs Triage in Contributions Apr 20, 2026

samuelallan72 approved these changes Apr 21, 2026

View reviewed changes

docs: update PDF embed instructions

1a4e730

Kelketek force-pushed the fox/update-pdf-editor branch from f0c89b0 to 1a4e730 Compare April 21, 2026 14:41

sarina reviewed Apr 21, 2026

View reviewed changes

fixup: remove unnecessary width constraint on image

a5768b9

sarina reviewed Apr 21, 2026

View reviewed changes

fixup: better alt text and image locations

e5609cd

sarina approved these changes Apr 21, 2026

View reviewed changes

sarina enabled auto-merge (squash) April 21, 2026 20:31

sarina merged commit 01a93d2 into openedx:main Apr 21, 2026
2 checks passed

github-project-automation Bot moved this from Needs Triage to Done in Contributions Apr 21, 2026

Kelketek deleted the fox/update-pdf-editor branch April 21, 2026 22:51

	You may optionally specify a specific URL for your PDF by selecting
	You may optionally specify a URL for your PDF by selecting

Conversation

Kelketek commented Apr 20, 2026 • edited by sarina Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Rendered doc

Uh oh!

openedx-webhooks commented Apr 20, 2026

Uh oh!

samuelallan72 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kelketek commented Apr 21, 2026

Uh oh!

sarina left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kelketek commented Apr 21, 2026

Uh oh!

sarina commented Apr 21, 2026

Uh oh!

Kelketek commented Apr 21, 2026

Uh oh!

sarina left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sarina left a comment

Choose a reason for hiding this comment

Uh oh!

Kelketek commented Apr 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Kelketek commented Apr 20, 2026 •

edited by sarina

Loading

samuelallan72 left a comment •

edited

Loading