Skip to content
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

docs: Update the about_lti_component doc #960

Merged
merged 1 commit into from
Mar 19, 2025

Conversation

MaferMazu
Copy link
Contributor

@MaferMazu MaferMazu commented Mar 19, 2025

Description

This PR updates the about_lti_component.

Details of changes:

  • Improve the intro paragraph.
  • Remove the duplicated accessibility note.
  • Improve the overview description.
  • Remove the tool consumer and tool provider explanation because they are platform and tool right now, and I don't think that info should be necessary for this concept page. Reference: https://www.imsglobal.org/spec/lti/v1p3#platforms-and-tools
  • Conver to a note of the bits of information.
  • Remove an outdated comment.
  • Move the reference of Using Open edX as an LTI Tool Provider to the See also section.
  • Complete the maintenance chart

How to test

https://docsopenedxorg--960.org.readthedocs.build/en/960/educators/concepts/exercise_tools/about_lti_component.html

Maintainance checks

  • Audience is defined
  • The Diataxis type is defined
  • RST standards are followed
  • Images are working and current
  • External links are working and accurate
  • See Also table is included
  • While reading the document, consider the standards defined in the [Open edX Documentation Writing Style Guide](https://docs.openedx.org/en/latest/documentors/references/doc_style_guide.html) (be focused on Grammar, details, etc).
  • Based on the diataxis type, test or validate the document:
    1. If the document is a how-to or quickstart, complete the steps as instructed and confirm that the outcome in your Open edX instance is the same as what the doc expects.
    2. If the document is a reference, confirm that the reference is complete and matches what you observe in your current Open edX version.
    3. If the document is a concept, confirm that the information is accurate and up-to-date
  • Complete the maintenance chart

@sarina sarina changed the title docs: update the about_lti_component doc docs: Update the about_lti_component doc Mar 19, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @MaferMazu!

This repository is currently maintained by @openedx/docs-openedx-org-maintainers.

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.


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 Mar 19, 2025
Copy link
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.

This is awesome, thank you! Do you want anyone else to review before I merge it?

@MaferMazu
Copy link
Contributor Author

This is ready to go. Thanks ✨

@sarina sarina merged commit 0622fc0 into openedx:main Mar 19, 2025
2 checks passed
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.

3 participants