Skip to content

docs: Updated educator docs for using Open edX as an LTI tool provider#1448

Open
ayub02 wants to merge 6 commits intoopenedx:mainfrom
ayub02:Verawood_openedx_as_lti_provider
Open

docs: Updated educator docs for using Open edX as an LTI tool provider#1448
ayub02 wants to merge 6 commits intoopenedx:mainfrom
ayub02:Verawood_openedx_as_lti_provider

Conversation

@ayub02
Copy link
Copy Markdown
Contributor

@ayub02 ayub02 commented May 5, 2026

This PR updates educator and site operator docs for Open edX as an LTI provider. These updates are a result of some testing that i've conducted with Canvas along with some code review via Claude.

At present, there are 12 pages in total for both educators and site operators. This PR reduces them to 6.

Site operator docs have been generated based on feedback from @feanil and code review from Claude Code.

Docs have been generated with help from Sonnet 4.6.

Note: I've deleted the Configuring Open edX User Authentication for LTI file because:

  1. The workflow described here doesn't work.
  2. It's a stand-alone document and doesn't overlap with the rest of the docs.
  3. Claude code says it's code is not related to the LTI provider app.

@sarina
Copy link
Copy Markdown
Contributor

sarina commented May 5, 2026

@ayub02 please ping me when this is ready for review or if you want help fixing build errors.

@ayub02 ayub02 requested review from feanil and sarina May 6, 2026 11:37
@ayub02 ayub02 marked this pull request as ready for review May 6, 2026 11:54
Copy link
Copy Markdown
Contributor

@sarina sarina left a comment

Choose a reason for hiding this comment

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

I still need to review enable_lti, index, and tpa_providers. I know it's a lot of comments, many are simply that "Open edX" has been repeatedly used as a noun when it needs to be used as an adjective.

Comment thread source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst Outdated
Comment thread source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst Outdated
Comment thread source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst Outdated
Comment thread source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst Outdated
Comment thread source/site_ops/install_configure_run_guide/configuration/lti/configure_lti.rst Outdated
Comment thread source/site_ops/install_configure_run_guide/configuration/lti/configure_lti.rst Outdated
Comment thread source/site_ops/install_configure_run_guide/configuration/lti/configure_lti.rst Outdated

.. seealso::

:ref:`Using Open edX as an LTI Tool Provider` (educator)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There's probably more that could be added here

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For example, the other Site Operators docs that relate to this topic.

Comment thread source/site_ops/install_configure_run_guide/configuration/lti/configure_lti.rst Outdated
Comment thread source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst Outdated
email already exists, the existing account is linked. This mode is useful when you need to identify
learners or associate their LTI activity with an existing Open edX account.

For this to work, configure your external LMS to include ``lis_person_contact_email_primary`` in
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[clarification] who has the ability to configure the external LMS?

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.

This will depend on the org. But my assumption is that it'll be educators is most cases since they'll be the ones creating content in Open edX, constructing URLs and then configuring those URLs in other LMSes.

Comment thread source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst Outdated
Comment thread source/site_ops/install_configure_run_guide/configuration/lti/configure_lti.rst Outdated
Comment thread source/site_ops/install_configure_run_guide/configuration/lti/configure_lti.rst Outdated
Comment thread source/site_ops/install_configure_run_guide/configuration/lti/index.rst Outdated
Comment thread source/site_ops/install_configure_run_guide/configuration/tpa/tpa_providers.rst Outdated
Comment thread source/site_ops/install_configure_run_guide/configuration/lti/index.rst Outdated
Comment thread source/site_ops/install_configure_run_guide/configuration/lti/index.rst Outdated
Comment thread source/site_ops/install_configure_run_guide/configuration/lti/index.rst Outdated
Comment thread source/site_ops/install_configure_run_guide/configuration/lti/configure_lti.rst Outdated
Comment thread source/site_ops/install_configure_run_guide/configuration/lti/configure_lti.rst Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants