docs: adds note about the auto linking flag in LTI Consumer configuration

tecoholic commented 1 year ago

A new flag was introduced in the LTI Consumer configuration which allows automatically linking LTI users with the edX platform users by matching the email ID. This commit describes the purpose of the flag with its caveats.

Ref: https://github.com/openedx/edx-platform/pull/33310

Date Needed (optional)

If the release date of a feature is known or estimated, provide it to give reviewers guidance on turnaround time.

Reviewers

Possible roles follow. The PR submitter checks the boxes after each reviewer finishes and gives :+1:.

[ ] Subject matter expert:
[ ] Subject matter expert:
[ ] Product review:
[ ] Partner support:
[ ] PM review:

FYI: Tag anyone else who might be interested in this PR here.

Testing

[ ] Ran ./run_tests.sh without warnings or errors

HTML Version (optional)

[ ] Build an RTD draft for your branch and add a link here

Sandbox (optional)

[ ] Point to or build a sandbox for the software change and add a link here

Post-review

[ ] Add a comment with the description of this change or link this PR to the next release notes task.
[ ] Squash commits

openedx-webhooks commented 1 year ago

Thanks for the pull request, @tecoholic! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

supporting documentation
Open edX discussion forum threads
timeline information ("this must be merged by XX date", and why that is)
partner information ("this is a course on edx.org")
any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

Cup0fCoffee commented 1 year ago

:+1:

[-] I tested this
[x] I read through the code
[x] Includes documentation

pdpinch commented 1 year ago

Is there a RTD version of this we can look at?

tecoholic commented 12 months ago

@pdpinch The previous CI run failed due to some issue with the RTD build. It is available here now.

On a related note, do you happen to know the right person I should ping for reviewing and merging this?

feanil commented 12 months ago

@tecoholic it should probably be reviewed and merged by the same person who reviews and merges https://github.com/openedx/edx-platform/pull/33310, if they don't have merge rights here, they can approve it and tag me and I can merge it for y'all.

Agrendalath commented 10 months ago

@feanil, would you mind merging this PR?

openedx-webhooks commented 10 months ago

@tecoholic 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

openedx / edx-documentation