Added LTI Store Documentation. by usmanpm · Pull Request #1288 · openedx/docs.openedx.org

usmanpm · 2025-10-01T12:46:19Z

Adding two new articles to the documentation:

Set up a Reusable LTI Store
Set up an LTI Consumer with Reusable LTI Configuration

openedx-webhooks · 2025-10-01T12:46:24Z

Thanks for the pull request, @usmanpm!

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.

sarina · 2025-10-01T19:56:05Z

Hi @usmanpm - let me know if/when I can help with the CLA or a review of the PR.

usmanpm · 2025-10-03T11:30:08Z

Hi @sarina, thanks for checking in. Yes please, I'd like some help with the CLA.
I've requested @feanil for review as I've been working with him on this, but please feel free to review.

P.S. This is my first PR in a very long time (I'm a Product Manager who doesn't usually dabble in code), so please let me know what I can do better in this one (and moving forward). Thanks!

sarina · 2025-10-03T12:42:17Z

@usmanpm do you work for an organization? If so you'll need to figure out how to get on their entity CLA.

sarina · 2025-10-03T12:42:50Z

+Set up an LTI Consumer with Reusable LTI Configuration
+######################################################
+
+.. tags:: educator, how-to, lti


Suggested change

.. tags:: educator, how-to, lti

.. tags:: educator, how-to

We only use tags for persona and article type, not subject area.

Removed the lti tag

sarina · 2025-10-03T12:43:00Z

+Set up a Reusable LTI Store
+###########################
+
+.. tags:: educator, how-to, lti


Suggested change

.. tags:: educator, how-to, lti

.. tags:: educator, how-to

Removed the lti tag

sarina · 2025-10-03T12:44:00Z

+.. note::
+   The following steps correspond to an **LTI 1.3 configuration**.
+
+1. Open Django Admin.


Suggested change

1. Open Django Admin.

#. Open Django Admin.

Use # signs instead of direct numbers, which will make it much easier to add/remove steps

Used # for all list items

sarina · 2025-10-03T12:44:15Z

+1. Open Django Admin.
+2. Navigate to: ``/admin/lti_store/externallticonfiguration/``  
+   (You must be logged in as a staff user with LTI Store model access.)
+3. Add a new **External LTI Configuration**.


Suggested change

3. Add a new **External LTI Configuration**.

3. Add a new **External LTI Configuration**.

You need a blank line here

Added blank lines after list items

sarina · 2025-10-03T12:45:28Z

+2. Navigate to: ``/admin/lti_store/externallticonfiguration/``  
+   (You must be logged in as a staff user with LTI Store model access.)
+3. Add a new **External LTI Configuration**.
+  .. image:: /_images/educator_how_tos/add_lti_store_configuration.png


Suggested change

.. image:: /_images/educator_how_tos/add_lti_store_configuration.png

.. image:: /_images/educator_how_tos/add_lti_store_configuration.png

You also need a blank line here. And images should include alt text, see https://docs.openedx.org/en/latest/documentors/references/quick_reference.html#directives

Added alt text for all images

feanil

@usmanpm I think sarina's suggestions are good and you can just apply them to fix various formatting issues.

For the CLA, Edly/Arbisoft needs to add you to their entity CLA, can you check in internal about that? They should be familiar with the process.

usmanpm · 2025-10-03T21:49:16Z

Thanks @sarina for the suggestions, I'll incorporate the fixes and resubmit. And yes, I'm from Arbisoft/Edly.

@feanil Sure thing, I'll check with the relevant folks. I preemptively filled out the CLA with my personal email address though, hope that's not an issue.

regisb · 2025-10-06T07:31:00Z

CLA email sent :)

feanil · 2025-10-06T15:32:18Z

+
+.. _IMS LTI Reference Implementation: https://lti-ri.imsglobal.org/keygen/index
+
+.. _Reference Tool: https://lti-ri.imsglobal.org/lti/tools/5621


Perhaps this should be a link to https://lti-ri.imsglobal.org/lti/tools
/5621 instead?

We should maybe clarify places where we mention this to say that you should create your own tools but here is an example one that you can use as reference.

Sure, it links to the reference tool (https://lti-ri.imsglobal.org/lti/tools/5621). It has since been moved inline to the Setting up an LTI Store page

docs.openedx.org/source/educators/how-tos/course_development/exercise_tools/setup_lti_store.rst

Line 112 in 86da269

* For testing purposes, use the `Reference Tool <https://lti-ri.imsglobal.org/lti/tools/5621>`_

feanil · 2025-10-06T15:33:00Z

 .. _AWS Documentation: http://aws.amazon.com/documentation/

 .. _Getting Help page: https://open.edx.org/getting-help
+


I think instead of putting these links in the links.rst file, we should put them in the files where we use them. This is a historic file.

Done. Added inline links, and removed from links.txt in 86da269

feanil

Changes look good to me!

* chore: documentation * add lti store config image for how-to * updated lti store config documentation and added images * added new page: set up lti consumer, added images * Incorporated suggested changes * Added inline links, removed links from links.txt

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 1, 2025

openedx-webhooks added this to Contributions Oct 1, 2025

github-project-automation Bot moved this to Needs Triage in Contributions Oct 1, 2025

usmanpm changed the title ~~chore: documentation~~ Draft LTI Store Documentation Oct 1, 2025

mphilbrick211 moved this from Needs Triage to Needs Tests Run or CLA Signed in Contributions Oct 2, 2025

usmanpm self-assigned this Oct 3, 2025

usmanpm requested a review from feanil October 3, 2025 11:27

usmanpm marked this pull request as ready for review October 3, 2025 11:30

usmanpm changed the title ~~Draft LTI Store Documentation~~ Added LTI Store Documentation Oct 3, 2025

sarina reviewed Oct 3, 2025

View reviewed changes

feanil reviewed Oct 3, 2025

View reviewed changes

usmanpm force-pushed the usmanpm/lti-store-documentation branch from c10a8aa to b09c050 Compare October 6, 2025 11:11

usmanpm added 5 commits October 6, 2025 11:16

chore: documentation

2041a7b

add lti store config image for how-to

2ced7c8

updated lti store config documentation and added images

7d5ae75

added new page: set up lti consumer, added images

ba7e037

Incorporated suggested changes

1bf1a77

usmanpm force-pushed the usmanpm/lti-store-documentation branch from b09c050 to 1bf1a77 Compare October 6, 2025 11:16

usmanpm requested a review from sarina October 6, 2025 11:22

feanil requested changes Oct 6, 2025

View reviewed changes

Added inline links, removed links from links.txt

86da269

usmanpm requested a review from feanil October 6, 2025 19:45

mphilbrick211 moved this from Needs Tests Run or CLA Signed to In Eng Review in Contributions Oct 6, 2025

feanil approved these changes Oct 7, 2025

View reviewed changes

feanil changed the title ~~Added LTI Store Documentation~~ Added LTI Store Documentation. Oct 7, 2025

feanil merged commit 91bb8da into openedx:main Oct 7, 2025
2 checks passed

github-project-automation Bot moved this from In Eng Review to Done in Contributions Oct 7, 2025

sarina mentioned this pull request Dec 5, 2025

Update LTI how-tos to separate site ops from educators docs #1339

Merged

	3. Add a new External LTI Configuration.
	3. Add a new External LTI Configuration.

	.. image:: /_images/educator_how_tos/add_lti_store_configuration.png
	.. image:: /_images/educator_how_tos/add_lti_store_configuration.png


		.. _IMS LTI Reference Implementation: https://lti-ri.imsglobal.org/keygen/index

		.. _Reference Tool: https://lti-ri.imsglobal.org/lti/tools/5621 No newline at end of file

		.. _AWS Documentation: http://aws.amazon.com/documentation/

		.. _Getting Help page: https://open.edx.org/getting-help

Conversation

usmanpm commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openedx-webhooks commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sarina commented Oct 1, 2025

Uh oh!

usmanpm commented Oct 3, 2025

Uh oh!

sarina commented Oct 3, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

feanil left a comment

Choose a reason for hiding this comment

Uh oh!

usmanpm commented Oct 3, 2025

Uh oh!

regisb commented Oct 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

feanil left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

usmanpm commented Oct 1, 2025 •

edited

Loading

openedx-webhooks commented Oct 1, 2025 •

edited

Loading