Skip to content

feat: PDF auto-conversion - #3201

Open
Kelketek wants to merge 1 commit into
openedx:masterfrom
open-craft:fox/pdf-auto-convert
Open

feat: PDF auto-conversion#3201
Kelketek wants to merge 1 commit into
openedx:masterfrom
open-craft:fox/pdf-auto-convert

Conversation

@Kelketek

@Kelketek Kelketek commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Description

This merge request enables auto-conversion of documents to PDF, provided the Gotenberg service is installed and configured.

Supporting information

Testing instructions

  1. Follow the instructions in the xblocks-core repository and use the linked version.
  2. Install this MFE in development mode according to the directions in the README
  3. Check out this branch
  4. Go to a course and find PDF in the advanced components. Add it.
  5. Attempt to upload a file. There should not be an option to upload office documents, but PDFs should work. Do the same with a library component. Likewise, you should only be able to use PDFs.
  6. Install the Tutor plugin for Gotenberg linked above
  7. Restart Tutor
  8. Go back to the course and try to upload an office document. This should work now.
  9. Try with the library block as well.

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

  • Any new files are using TypeScript (.ts, .tsx).
  • Avoid propTypes and defaultProps in any new or modified code.
  • Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use.
  • Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

@openedx-webhooks 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 Aug 20, 2026
@openedx-webhooks

openedx-webhooks commented Aug 20, 2026

Copy link
Copy Markdown

Thanks for the pull request, @Kelketek!

This repository is currently maintained by @bradenmacdonald.

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.

id: 'authoring.pdfEditor.formGroups.downloadOptions.sourceUrl.hint',
defaultMessage: 'Add a link to the original or editable file (e.g. Word or PowerPoint). Appears as a separate link.',
defaultMessage: 'Add a link to the original or editable file (e.g. Word or PowerPoint). Appears as a separate '
+ 'link. You are strongly recommended to include this as PDFs have significant accessibility limitations.',

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

PDFs can be made as accessible (or not) as Word or PowerPoint files. I suggest a more general reminder that uploaded files need to be made natively accessible, or also upload clearly identified conforming alternative versions.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@wittjeff Looked into it and you're right. I've only ever thought of PDFs as a postscript format for printers and every attempt I've had to try to extract useful text from them tends to be frustrating, but the format supports much better accessibility than I realized.

I've updated the phrasing here. Let me know if it works for you.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Aug 26, 2026
@Kelketek
Kelketek force-pushed the fox/pdf-auto-convert branch from 0ee344e to 5c633d5 Compare August 26, 2026 21:17
@codecov

codecov Bot commented Aug 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.95%. Comparing base (de0e1c4) to head (ff9a08c).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3201      +/-   ##
==========================================
+ Coverage   95.91%   95.95%   +0.03%     
==========================================
  Files        1397     1397              
  Lines       33558    33607      +49     
  Branches     7914     7681     -233     
==========================================
+ Hits        32187    32246      +59     
- Misses       1312     1317       +5     
+ Partials       59       44      -15     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Kelketek
Kelketek force-pushed the fox/pdf-auto-convert branch from 286cc00 to ff9a08c Compare August 28, 2026 01:04
@Kelketek
Kelketek marked this pull request as ready for review August 28, 2026 01:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

4 participants