Skip to content

Conversation

@samuelallan72
Copy link
Contributor

@samuelallan72 samuelallan72 commented Jan 6, 2026

Description

The setting to share user emails and usernames with LTI components is behind a flag that can be set from the Django admin. Add documentation for how to set this flag.

Supporting information

Private-ref: https://tasks.opencraft.com/browse/BB-6337

Testing instructions

  • view the page updates and verify the pages are rendered as expected
  • check the accuracy of the new page
  • [internal OpenCraft reviewers] verify this covers the content from this internal doc

See CI rendered pages at:

The setting to share user emails and usernames with LTI components
is behind a flag that can be set from the Django admin.
Add documentation for how to set this flag.

Private-ref: https://tasks.opencraft.com/browse/BB-6337
@openedx-webhooks
Copy link

Thanks for the pull request, @samuelallan72!

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 6, 2026
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jan 6, 2026
Copy link

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

@samuelallan72 Thanks!

@samuelallan72
Copy link
Contributor Author

Thanks @navinkarkera

@openedx/wg-maintenance-docs.openedx.org this is ready for engineering review, thanks. :)


To make this setting available in Studio, a system administrator must
enable the setting in the Django administration console.
See :ref:`Allow sharing PII to LTI Components` for how to enable
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add this ref to the seealso table as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, thanks! :)


.. seealso::

:ref:`LTI Component settings` (reference)
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you please add a maintenance table to this document?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, thank for your review! :)

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Jan 6, 2026
Add links and chart in response to review
@sarina
Copy link
Contributor

sarina commented Jan 7, 2026

@samuelallan72 question for you, would you consider that you've reviewed these pages (on Teak? on Ulmo?) and verified them to work? If yes, I'd fill out the Maintenance Table on these pages with a "Pass"

@samuelallan72
Copy link
Contributor Author

@sarina unfortunately not completely yet - I've tested the django admin flow described, but haven't verified it does indeed allow sharing with LTI components (I'm not familiar with an LTI component where I can test this).

This is a port (and update) of an internal document we've had for a while, so it hasn't been tested recently either.

@sarina
Copy link
Contributor

sarina commented Jan 8, 2026

We'd defiinitely appreciate your testing the instructions when you get the opportunity.

@sarina sarina merged commit 6199684 into openedx:main Jan 8, 2026
2 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Jan 8, 2026
@samuelallan72
Copy link
Contributor Author

Thanks @sarina !

@samuelallan72 samuelallan72 deleted the samuel/document-sharing-pii-lti branch January 8, 2026 21:46
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

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants