`Development`: Migrate lti configuration documentation #11774

az108 · 2025-12-04T22:32:56Z

Checklist

General

This is a small issue that I tested locally
Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
I chose a title conforming to the naming conventions for pull requests.

Motivation and Context

We want to migrate to the new documentation https://ls1intum.github.io/Artemis/ from https://artemis-platform.readthedocs.io/en/latest/index.html to provide a more modern and user friendly access to additional information around Artemis.

Description

Migrating the Lti Configuration section to the new documentation
Splitting it into the Instructor documentation
Simplifying explanations and making them more user friendly (less text, more bullet points)
Removing that part from the old documentation and linking to the new documentation

Steps for Testing

Run npm install and npm start in the /documentation folder

Verify http://localhost:3000/Artemis/instructor/lti-configuration is clear and understandable
Verify you are not missing information that you think would be required

Review Progress

Manual Tests

Test 1

Summary by CodeRabbit

Documentation
- Enhanced LTI integration documentation with comprehensive guides for Moodle and edX configuration, including step-by-step setup procedures, deep linking instructions, and troubleshooting resources. Documentation is now organized in the instructor resources section.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-04T22:36:55Z

Walkthrough

Large LTI documentation content has been relocated from the user guide to a new instructor-focused documentation file. The original documentation file now contains a redirect notice, and the sidebar has been updated to include the new documentation entry.

Changes

Cohort / File(s)	Summary
Documentation Consolidation `docs/user/lti.rst`	Existing LTI documentation replaced with a notice directing readers to new instructor documentation
New LTI Configuration Guide `documentation/docs/instructor/lti-configuration.mdx`	New comprehensive MDX documentation covering LTI configuration, including overview, online course setup, dynamic and manual registration, content linking, user provisioning, platform-specific steps for Moodle and edX, troubleshooting, illustrative images, notes, warnings, and embedded video demonstrations
Sidebar Navigation Update `documentation/sidebar-instructors.ts`	Added `lti-configuration` entry to the default sidebar array in `SidebarsConfig`

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Verify the redirect notice in the old documentation file appropriately guides users to the new location
Confirm the new documentation content is comprehensive and platform-specific instructions are accurate
Check that the sidebar entry is correctly positioned and properly references the new documentation file

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: migrating LTI configuration documentation from the old ReadTheDocs site to the new Artemis documentation site.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch chore/general/migtate-lti-configuration-documentation

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 4

🧹 Nitpick comments (1)

documentation/docs/instructor/lti-configuration.mdx (1)
333-333: Optional: Simplify phrasing.

The phrase "drop down the list" could be simplified to "open the dropdown" or "select from the dropdown" for clarity.
-4. In the *External Tool Settings* section, drop down the list to select the appropriate LTI platform configuration for your course.
+4. In the *External Tool Settings* section, open the dropdown to select the appropriate LTI platform configuration for your course.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f99517 and 7b1420f.

⛔ Files ignored due to path filters (27)

documentation/docs/instructor/assets/lti-configuration/artemis_moodle_field_mapping.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/course-management.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/course_edit_lti_configuration.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/course_settings_button.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/edx_add_exercise_link.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/edx_artemis_mapping.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/edx_change_course_live.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/edx_lti_consumer_settings.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/enable_onlinecourse.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/lti_lectures_list.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/ltiexercises_list.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_activate_lti.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_add_external_tool.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_add_external_tool_page.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_add_tool_url.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_artemis_field_mapping.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_artemis_progex.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_editmode.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_password_popup.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_select-exercise.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_select_content.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_select_content_link.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_select_content_link_grouped.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_select_content_new.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/moodle_site_administration.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/server_lti_config_service_urls.png is excluded by !**/*.png, !**/*.png
documentation/docs/instructor/assets/lti-configuration/server_lti_configuration.png is excluded by !**/*.png, !**/*.png

📒 Files selected for processing (3)

docs/user/lti.rst (1 hunks)
documentation/docs/instructor/lti-configuration.mdx (1 hunks)
documentation/sidebar-instructors.ts (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: basak-akan
Repo: ls1intum/Artemis PR: 0
File: :0-0
Timestamp: 2024-06-10T19:44:09.116Z
Learning: The navigation path "admin/lti-configuration" is correctly configured and functioning properly in the Artemis platform as confirmed by the user.

📚 Learning: 2025-06-10T12:33:55.645Z

Learnt from: Wallenstein61
Repo: ls1intum/Artemis PR: 10989
File: src/main/webapp/app/programming/shared/actions/programming-exercise-instructor-exercise-sharing.component.ts:57-61
Timestamp: 2025-06-10T12:33:55.645Z
Learning: In the Artemis sharing platform integration, redirect URLs returned from the sharing service are generated by Artemis's own backend and secured with checksums, making them safe from open redirect vulnerabilities. The sharing platform integration uses a secure communication model with API keys and checksum validation.

Applied to files:

docs/user/lti.rst
documentation/docs/instructor/lti-configuration.mdx

📚 Learning: 2024-06-10T19:44:09.116Z

Learnt from: basak-akan
Repo: ls1intum/Artemis PR: 0
File: :0-0
Timestamp: 2024-06-10T19:44:09.116Z
Learning: The navigation path "admin/lti-configuration" is correctly configured and functioning properly in the Artemis platform as confirmed by the user.

Applied to files:

docs/user/lti.rst
documentation/docs/instructor/lti-configuration.mdx

🪛 LanguageTool

documentation/docs/instructor/lti-configuration.mdx

[style] ~227-~227: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...RL* into Redirection URI(s) field. 9. Copy Initiate login URL into the *Initiate...