fix(docs): update flex installation prerequisites #2547
Conversation
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
📝 WalkthroughWalkthroughDocumentation updates redirect Software Statement Assertion (SSA) prerequisite references from Agama Lab to Flex across twelve installation and administrative guides. The Flex prerequisites page is enhanced with license guidance and a new section listing required Gluu endpoints (account.gluu.org, cloud.gluu.org) for whitelist configuration. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Suggested labels
Suggested reviewers
Poem
Pre-merge checks✅ Passed checks (5 passed)
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. Comment |
mo-auto
added
area-documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (13)
docs/admin/admin-ui/faq.mddocs/admin/admin-ui/introduction.mddocs/admin/recipes/getting-started-rancher.mddocs/install/flex/prerequisites.mddocs/install/helm-install/amazon-eks.mddocs/install/helm-install/google-gke.mddocs/install/helm-install/local.mddocs/install/helm-install/microsoft-azure.mddocs/install/helm-install/rancher.mddocs/install/vm-install/rhel.mddocs/install/vm-install/suse.mddocs/install/vm-install/ubuntu.mdmkdocs.yml
🧰 Additional context used
🪛 LanguageTool
docs/install/flex/prerequisites.md
[grammar] ~47-~47: Use a hyphen to join words.
Context: ...in the above step to either request a 30 day trial license or verify presence of ...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
docs/install/flex/prerequisites.md
54-54: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
55-55: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🔇 Additional comments (13)
docs/admin/admin-ui/introduction.md (1)
31-31: Link update looks correct.The SSA prerequisites link has been successfully updated to point to the Flex prerequisites documentation. The surrounding text mentioning "Agama Lab" as the web interface name remains appropriate.
docs/admin/recipes/getting-started-rancher.md (1)
213-213: Link update is correct.The SSA prerequisites link has been properly updated to reference the Flex prerequisites documentation, consistent with the PR objectives.
docs/install/helm-install/local.md (1)
40-40: Link update looks good.The prerequisites link has been correctly updated to point to the Flex-specific prerequisites documentation.
docs/install/vm-install/rhel.md (1)
34-34: Link update is correct.The SSA prerequisites link has been properly redirected to the Flex prerequisites page.
docs/install/vm-install/suse.md (1)
34-34: Link update looks correct.The prerequisites reference has been successfully updated to the Flex prerequisites documentation.
docs/install/helm-install/google-gke.md (1)
20-20: Link update is correct.The SSA prerequisites link properly references the Flex prerequisites documentation.
mkdocs.yml (1)
117-117: Navigation update is correct and file cleanup is complete.The Flex prerequisites file exists at
docs/install/flex/prerequisites.md, the old Agama prerequisites file has been properly removed, and the mkdocs.yml navigation entry is correctly updated.docs/install/helm-install/rancher.md (1)
20-20: The link to the Flex prerequisites is valid. Both anchor sections exist in the target file (docs/install/flex/prerequisites.md): "Obtaining an SSA" and "Software Statement Assertions". The anchor#obtaining-an-ssaused in this file is correct and points to the appropriate section for the context of obtaining an SSA.docs/install/helm-install/amazon-eks.md (1)
19-19: Verify SSA link aligns with PR updates across other files.This line points to
install/agama/flex/#obtaining-an-ssa, but other files updated toinstall/flex/prerequisites/(microsoft-azure.md, ubuntu.md, faq.md). Ensure consistency with the PR objective of redirecting SSA references to the Flex prerequisites page.docs/install/helm-install/microsoft-azure.md (1)
19-19: LGTM!The SSA link correctly points to the Flex prerequisites page, aligning with the PR objectives.
docs/install/vm-install/ubuntu.md (1)
23-23: LGTM!The SSA link correctly points to the Flex prerequisites page, aligning with the PR objectives.
docs/admin/admin-ui/faq.md (1)
48-48: LGTM!The SSA guide link correctly points to the Flex prerequisites page.
docs/install/flex/prerequisites.md (1)
51-55: Fix Markdown list indentation in "Allow Gluu Endpoints Access in Flex" section.The sub-items (lines 54-55) should use 2-space indentation, not 4 spaces, to align with Markdown best practices and linting rules.
🔎 Proposed fix
## Allow Gluu Endpoints Access in Flex - Flex requires outbound access to the following Gluu endpoints. Please ensure these domains are whitelisted in the Flex environment. - - account.gluu.org - - cloud.gluu.org + - account.gluu.org + - cloud.gluu.org⛔ Skipped due to learnings
Learnt from: duttarnab Repo: GluuFederation/flex PR: 2444 File: docs/admin/admin-ui/access-control.md:18-49 Timestamp: 2025-11-17T12:38:43.830Z Learning: In the GluuFederation/flex repository documentation files (docs/admin/admin-ui/*.md), nested list items may intentionally use 4-space indentation instead of the standard 2-space indentation to create clearer visual hierarchy and grouping in rendered documentation, even if this triggers markdownlint MD007 warnings.
|
|
Closes #2546
Summary by CodeRabbit
Release Notes
✏️ Tip: You can customize this high-level summary in your review settings.