Fix link to the authentication with Amazon Cognito #8877
Conversation
WalkthroughThe documentation for social authentication configuration in the enterprise documentation has been updated to improve clarity, structure, and readability. The changes include adding an Enterprise client note, reformatting authentication options, streamlining language, and providing more consistent and detailed instructions for configuring Google, GitHub, and Amazon Cognito authentication methods. Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@SpecLad, 👀 |
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (2)
site/content/en/docs/enterprise/social-accounts-configuration.md (2)
Line range hint
47-48: Fix typo in Google callback URL.There's a typo in the callback URL example:
-https://localhost:8080/api/auth/social/goolge/login/callback/ +https://localhost:8080/api/auth/social/google/login/callback/
Line range hint
58-58: Fix missing quotes in environment variable examples.The AUTH_CONFIG_PATH environment variable is missing a closing quote in multiple places throughout the document.
-AUTH_CONFIG_PATH="<path_to_auth_config> +AUTH_CONFIG_PATH="<path_to_auth_config>"Also applies to: 89-89, 156-160
🧹 Nitpick comments (1)
site/content/en/docs/enterprise/social-accounts-configuration.md (1)
Line range hint
1-180: Consider adding screenshots for Google and GitHub configurations.The Amazon Cognito section includes helpful screenshots that make the configuration process clearer. Consider adding similar screenshots for the Google and GitHub configuration sections to maintain consistency across the document.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
site/content/en/docs/enterprise/social-accounts-configuration.md(3 hunks)
🔇 Additional comments (2)
site/content/en/docs/enterprise/social-accounts-configuration.md (2)
22-24: Navigation links are now correctly formatted.
The links to all authentication sections, including the previously broken Amazon Cognito link, are now properly formatted and functional.
Line range hint 103-115: Well-structured documentation with clear sections.
The document structure is clear and logical, with a good breakdown of steps for Amazon Cognito configuration. The use of subsections makes it easy to follow the setup process.
Motivation and context
I haven't noticed that #8557 broke the link to the section about authentication with Amazon Cognito service.
How has this been tested?
Checklist
developbranch(cvat-canvas,
cvat-core,
cvat-data and
cvat-ui)
License
Feel free to contact the maintainers if that's a concern.
Summary by CodeRabbit