-
Notifications
You must be signed in to change notification settings - Fork 78
feat: document how to share pii to lti components #1368
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.
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
feat: document how to share pii to lti components #1368
Conversation
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
|
Thanks for the pull request, @samuelallan72! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
navinkarkera
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@samuelallan72 Thanks!
|
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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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! :)
Add links and chart in response to review
|
@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" |
|
@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. |
|
We'd defiinitely appreciate your testing the instructions when you get the opportunity. |
|
Thanks @sarina ! |
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
See CI rendered pages at: