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

Update LTI documentation to correct URLs for redirect #2184

Merged
merged 1 commit into from
Aug 27, 2024

Conversation

20wildmanj
Copy link
Contributor

Update target_link_uri, oidc_initiation_url in LTI integration pages so that the examples doesn't have ending forward-slashes.

Also update README.md commands for documentation to use python3 -m in front of mkdocs commands. This command is more likely to work out of the box compared to just mkdocs

Description

Motivation and Context

Closes #2179

How Has This Been Tested?

Run the documentation server locally, see the following for example configuration where url/uris don't have ending forward-slashes

Screenshot 2024-08-23 at 11 29 58 PM

… doesn't have ending forward-slashes.

Also update README.md commands for documentation to use python3 -m infront of mkdocs
@20wildmanj 20wildmanj requested review from a team and jlge and removed request for a team August 24, 2024 03:30
Copy link
Contributor

coderabbitai bot commented Aug 24, 2024

Walkthrough

Walkthrough

The modifications involve updating the commands for running and deploying documentation using MkDocs and standardizing URL formatting in the LTI integration JSON configuration. The command for serving documentation is changed to explicitly use Python 3, while trailing slashes are removed from specific URLs in the LTI integration to ensure proper endpoint resolution.

Changes

File Change Summary
README.md, docs/installation/lti_integration.md Updated MkDocs command invocation to python3 -m mkdocs serve and removed trailing slashes from specified URLs in LTI integration JSON.

Assessment against linked issues

Objective Addressed Explanation
LTI Integration with Canvas - Invalid Redirect URI (#[2179])
Clarification on the platform field in JSON (#[2179]) The change does not address this concern directly.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7b529d3 and b13e988.

Files selected for processing (2)
  • README.md (1 hunks)
  • docs/installation/lti_integration.md (2 hunks)
Files skipped from review due to trivial changes (1)
  • README.md
Additional comments not posted (3)
docs/installation/lti_integration.md (3)

66-66: LGTM: Trailing slash removed from oidc_initiation_url.

Removing the trailing slash ensures consistency in URL handling and prevents potential issues with endpoint resolution.


67-67: LGTM: Trailing slash removed from target_link_uri.

This change aligns with best practices for URL formatting and helps prevent issues related to endpoint resolution.


86-86: LGTM: Trailing slash removed from nested target_link_uri.

Ensures consistent URL formatting across the configuration, which is important for integration reliability.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@jlge jlge left a comment

Choose a reason for hiding this comment

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

lgtm!
image

@20wildmanj 20wildmanj added this pull request to the merge queue Aug 27, 2024
Merged via the queue into master with commit 4f4d3fd Aug 27, 2024
5 checks passed
@20wildmanj 20wildmanj deleted the joeywildman-update-lti-docs branch August 27, 2024 17:00
@coderabbitai coderabbitai bot mentioned this pull request Oct 4, 2024
3 tasks
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.

LTI Integration with Canvas - Invalid Redirect URI
2 participants