fix(docs): fix linting issues - trailing spaces and EOF newline #2548
Conversation
Signed-off-by: ossdhaval <[email protected]>
Signed-off-by: ossdhaval <[email protected]>
📝 WalkthroughWalkthroughWidespread documentation edits across the repository: whitespace and markdown reflow, punctuation and grammar fixes, minor content clarifications, a few added headings/subsections, and small table adjustments. No code, API signatures, or runtime behavior were changed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (2)
🧰 Additional context used🧠 Learnings (2)📓 Common learnings📚 Learning: 2025-11-17T12:38:43.830ZApplied to files:
🪛 markdownlint-cli2 (0.18.1)docs/admin/admin-ui/user-management-menu.md39-39: Trailing spaces (MD009, no-trailing-spaces) 44-44: Unordered list indentation (MD007, ul-indent) 🔇 Additional comments (1)
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-CI
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 15
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/solo/solo-subscription.md (1)
23-23: Add alt text to all images in the subscription walkthrough.Multiple images throughout the subscription steps lack descriptive alt text. Each image should include meaningful alternative text for accessibility.
🔎 Example fix for images
-  +  -  + Apply similar meaningful alt text to all other images in the subscription steps.
Also applies to: 30-30, 37-37, 43-43, 46-46, 55-55, 57-57, 66-66, 73-73, 80-80, 87-87, 94-94, 101-101, 107-107
📜 Review details
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (49)
README.mdautomation/rancher-partner-charts/app-readme.mdautomation/rancher-partner-charts/pull_request_body.mddocker-flex-monolith/README.mddocs/README.mddocs/admin/README.mddocs/admin/admin-ui/auth-server-interaction.mddocs/admin/admin-ui/auth-server-menu.mddocs/admin/admin-ui/configuration.mddocs/admin/admin-ui/faq.mddocs/admin/admin-ui/fido-menu.mddocs/admin/admin-ui/introduction.mddocs/admin/admin-ui/logs.mddocs/admin/admin-ui/saml-menu.mddocs/admin/admin-ui/scim-menu.mddocs/admin/admin-ui/scripts.mddocs/admin/admin-ui/services-menu.mddocs/admin/admin-ui/user-claims.mddocs/admin/admin-ui/user-management-menu.mddocs/admin/admin-ui/webhooks.mddocs/admin/gluu-migration.mddocs/admin/kubernetes-ops/README.mddocs/admin/kubernetes-ops/admin-ui-private.mddocs/admin/kubernetes-ops/upgrade.mddocs/admin/recipes/getting-started-rancher.mddocs/admin/recipes/testing-flex-saml-sso-sptest.mddocs/install/README.mddocs/install/docker-install/compose.mddocs/install/docker-install/quick-start.mddocs/install/helm-install/README.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.mddocs/openbanking/configuration-instructions.mddocs/openbanking/curl.mddocs/openbanking/index.mddocs/openbanking/install-cn.mddocs/openbanking/install-vm.mddocs/openbanking/jans-cli.mddocs/openbanking/par-jarm.mddocs/reference/kubernetes/docker-flex-monolith.mddocs/solo/solo-administration-guide.mddocs/solo/solo-getting-started.mddocs/solo/solo-subscription.md
🧰 Additional context used
🧠 Learnings (5)
📓 Common 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.
📚 Learning: 2025-11-11T15:45:04.151Z
Learnt from: devrimyatar
Repo: GluuFederation/flex PR: 2442
File: flex-linux-setup/flex_linux_setup/flex_setup.py:372-374
Timestamp: 2025-11-11T15:45:04.151Z
Learning: In flex-linux-setup/flex_linux_setup/flex_setup.py, the Admin UI policy store JSON file is downloaded from the main branch of the GluuFlexAdminUIPolicyStore repository (https://raw.githubusercontent.com/GluuFederation/GluuFlexAdminUIPolicyStore/refs/heads/main/2fb50e468d9dfefa142d1fce4fa9747efbd3a0f08de5.json). This file is regularly updated, so static checksums are not feasible. The download is handled by base.download() which includes built-in error handling, and JSON validation is performed after download to ensure file integrity before rendering the template.
Applied to files:
docs/install/vm-install/ubuntu.mddocs/admin/README.mddocs/install/vm-install/rhel.md
📚 Learning: 2025-11-11T15:17:34.651Z
Learnt from: devrimyatar
Repo: GluuFederation/flex PR: 2440
File: flex-linux-setup/flex_linux_setup/flex_setup.py:519-519
Timestamp: 2025-11-11T15:17:34.651Z
Learning: In flex-linux-setup/flex_linux_setup/flex_setup.py, the webhook LDIF (aui_webhook.ldif) should only be imported during fresh Admin UI installations, not during updates. The import is correctly guarded by the check `client_check_result['2001.'] == -1` which ensures it only runs when the Admin UI Web Client doesn't already exist. Docker update workflows differ from Linux update workflows in this regard.
Applied to files:
docs/install/vm-install/ubuntu.mddocs/install/vm-install/rhel.md
📚 Learning: 2025-11-05T19:57:35.143Z
Learnt from: faisalsiddique4400
Repo: GluuFederation/flex PR: 2415
File: admin-ui/plugins/auth-server/components/Ssa/SsaAddPage.tsx:148-153
Timestamp: 2025-11-05T19:57:35.143Z
Learning: In the SSA Add page (admin-ui/plugins/auth-server/components/Ssa/SsaAddPage.tsx), the Back button should fall back to '/auth-server/config/ssa' when browser history is unavailable, not '/home/dashboard', as this keeps users in the SSA management context.
Applied to files:
docs/admin/admin-ui/faq.md
📚 Learning: 2025-11-26T12:25:34.923Z
Learnt from: faisalsiddique4400
Repo: GluuFederation/flex PR: 2475
File: admin-ui/plugins/auth-server/components/Clients/ClientDetailPage.js:111-216
Timestamp: 2025-11-26T12:25:34.923Z
Learning: In the admin-ui codebase, avoid suggesting comments for small functionalities or straightforward layout decisions in smaller components. Comments should be reserved for more complex or non-obvious logic.
Applied to files:
docs/admin/admin-ui/introduction.md
🪛 Gitleaks (8.30.0)
docs/openbanking/curl.md
[high] 47-47: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.
(curl-auth-user)
[high] 78-84: Discovered a potential authorization token provided in a curl command header, which could compromise the curl accessed resource.
(curl-auth-header)
🪛 LanguageTool
docs/openbanking/install-cn.md
[grammar] ~92-~92: Use a hyphen to join words.
Context: ...e=ca.crt=ca.crt ``` 1. Inject OBIE signed certs, keys and uri: 1. Wh...
(QB_NEW_EN_HYPHEN)
automation/rancher-partner-charts/app-readme.md
[uncategorized] ~17-~17: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... - Identity federation ### Free Open Source Software The Gluu Server is a FOSS plat...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/solo/solo-subscription.md
[style] ~11-~11: Consider a more concise word here.
Context: ...s require active Gluu Solo subscription in order to avail Gluu Solo services. Customers can...
(IN_ORDER_TO_PREMIUM)
docs/openbanking/jans-cli.md
[grammar] ~2-~2: Use a hyphen to join words.
Context: ## Introduction Jans-cli is a command line interface to configure the Janssen ...
(QB_NEW_EN_HYPHEN)
docs/install/helm-install/rancher.md
[grammar] ~17-~17: Use a hyphen to join words.
Context: ...loying an Ingress controller on a single node deployment, in which Ingress utiliz...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
docs/openbanking/install-vm.md
22-22: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
115-115: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
automation/rancher-partner-charts/app-readme.md
17-17: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
docs/admin/admin-ui/user-management-menu.md
43-43: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
43-43: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
docs/admin/recipes/getting-started-rancher.md
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
docs/admin/recipes/testing-flex-saml-sso-sptest.md
76-76: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
76-76: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
78-78: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
80-80: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
80-80: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/install/helm-install/google-gke.md
28-28: Ordered list item prefix
Expected: 5; Actual: 4; Style: 1/2/3
(MD029, ol-prefix)
docs/openbanking/configuration-instructions.md
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
docs/admin/kubernetes-ops/admin-ui-private.md
93-93: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
101-101: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/install/docker-install/compose.md
11-11: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
docs/admin/admin-ui/scripts.md
29-29: Link text should be descriptive
(MD059, descriptive-link-text)
docs/solo/solo-administration-guide.md
20-20: Images should have alternate text (alt text)
(MD045, no-alt-text)
docs/openbanking/jans-cli.md
155-155: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
docs/install/vm-install/suse.md
115-115: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
115-115: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
docs/admin/admin-ui/services-menu.md
70-70: Trailing spaces
Expected: 0 or 2; Actual: 4
(MD009, no-trailing-spaces)
docs/openbanking/par-jarm.md
9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
docker-flex-monolith/README.md
11-11: Trailing spaces
Expected: 0 or 2; Actual: 3
(MD009, no-trailing-spaces)
docs/admin/admin-ui/saml-menu.md
66-66: Ordered list item prefix
Expected: 7; Actual: 11; Style: 1/2/3
(MD029, ol-prefix)
69-69: Ordered list item prefix
Expected: 8; Actual: 12; Style: 1/2/3
(MD029, ol-prefix)
docs/install/vm-install/rhel.md
109-109: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
109-109: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🔇 Additional comments (60)
docs/admin/kubernetes-ops/upgrade.md (1)
20-20: ✓ Linting fix approved.The addition of an EOF newline addresses the documentation linting issue without affecting content. The helm upgrade command and overall guide structure remain intact.
docs/admin/kubernetes-ops/admin-ui-private.md (1)
13-14: Whitespace adjustments are reasonable for linting compliance.The blank line removals throughout the file (lines 54, 64, 70, 88, 96, 104, 107) align with standard markdown formatting practices and should improve linting compliance. The minor text adjustment on line 13 is also appropriate.
Also applies to: 54-54, 64-64, 70-70, 88-88, 96-96, 104-104, 107-107
docs/admin/admin-ui/faq.md (2)
32-43: Well-structured error explanation with clear troubleshooting steps.The 500 error section is well-organized with actionable steps for users to diagnose token generation issues. The formatting and list structure are appropriate for documentation.
64-64: EOF formatting properly handled.The trailing whitespace removal and EOF newline fix appear correct, maintaining proper file termination for documentation standards.
docs/admin/gluu-migration.md (1)
34-34: Formatting fixes align with PR objectives.The changes to lines 34 and 90 (removing trailing whitespace) and the addition of an EOF newline are appropriate for this linting-focused PR. These formatting adjustments have no impact on the documentation content or structure.
Also applies to: 90-90
docs/admin/admin-ui/services-menu.md (3)
70-70: No fix needed — line 70 already has no trailing spaces.Line 70 currently ends with
|followed by end-of-line (no trailing spaces). The line is already in the correct format per markdown linting standards.Likely an incorrect or invalid review comment.
96-96: Markdown table syntax is valid and properly aligned.The Persistence section table at line 96 follows correct markdown syntax with consistent column width alignment. The separator row dashes match the column widths, and all rows maintain proper pipe delimiters and spacing.
81-82: No action needed — markdown table formatting is valid and consistent.The table at lines 80-84 (including the separator at line 81 and data row at line 82) uses correct markdown syntax and is consistent with other tables in the document.
docs/solo/solo-administration-guide.md (1)
13-48: Line wrapping for readability looks good.The sentence reflowing across these sections improves readability without altering content or introducing markdown syntax issues.
docs/solo/solo-subscription.md (1)
15-16: Line wrapping for readability is appropriate.The reflowing of the subscription introduction text maintains clarity without introducing issues.
docs/solo/solo-getting-started.md (3)
10-13: Improved opening paragraph provides better context.The expanded and reflowed introduction now more clearly articulates the value proposition of Gluu Solo as a cloud-based service. The addition of "dedicated authentication solutions" provides helpful specificity.
15-15: Good addition of Gluu Solo reference link.Adding a hyperlink to the official Gluu Solo website provides users with an easy path to learn more about features and benefits.
37-40: Reworded subscription section improves clarity.The rephrased subscription description—particularly changing to "aligns with your identity management requirements"—is more specific and helpful than generic phrasing. The line-wrapping also improves readability.
docs/openbanking/par-jarm.md (3)
2-5: Verify that trailing spaces and EOF newline issues are fully resolved.The PR description mentions fixing trailing spaces and EOF newline issues, but these cannot be verified from the annotated diff format (which doesn't display raw whitespace). Please confirm that:
- All trailing spaces have been removed from the changed lines
- The file ends with exactly one newline character (no missing or excess EOF newlines)
Consider running a linting tool locally (e.g.,
markdownlint,mdl) on the file to validate all whitespace-related issues are resolved.Also applies to: 10-10, 33-35
18-29: Content improvements are well-structured.The additions of PAR configuration properties (
parEndpoint,requirePar,parLifetime) are clearly documented with descriptions of their purposes and behaviors. The expanded JWT/JARM section with mentions of security benefits (audience restriction, replay protection, credential leakage protection, mix-up attacks) enhances the documentation's completeness.Also applies to: 33-36
1-2: Check: First heading also lacks blank line after it.Similar to line 9, line 1's main heading also has no blank line between it and the content starting at line 2. Verify whether this is also a violation that should be fixed or if the project's MD022 configuration allows the first heading to omit a trailing blank line.
docs/install/vm-install/suse.md (2)
59-60: Whitespace cleanup around verification section.The modification of lines 59–60 appears to address trailing space or blank line spacing around the "Verify integrity" paragraph. This aligns with the PR's objective of fixing documentation formatting. Assuming the changes remove excess whitespace and normalize spacing, this looks appropriate.
247-250: Minor formatting adjustment approved.The modification normalizes spacing around the "Remove package" command section, consistent with the PR's formatting objectives. No functional changes to content.
docs/install/vm-install/ubuntu.md (4)
26-29: Ubuntu 20.04 support addition is appropriate.Adding Ubuntu 20.04 to the supported versions list expands platform coverage beyond the minimum currently documented (24.04 and 22.04). This aligns with broadening installation guide accessibility and is a valuable enhancement.
36-44: GPG key section indentation and formatting looks good.The reformatted GPG key download section with adjusted indentation improves readability and consistency. The command structure and functionality remain unchanged.
50-52: Whitespace normalization across verification sections.Lines 50–52, 54–55, 84–85, and 114–115 contain formatting adjustments to the "Verify integrity" sections across Ubuntu version subsections. These changes appear to normalize spacing and remove trailing whitespace, which aligns with the PR's objective.
Also applies to: 54-55, 84-85, 114-115
312-312: EOF newline properly added.Line 312 shows the addition of a trailing newline at end-of-file, which resolves linting requirements for proper file termination.
docs/install/vm-install/rhel.md (2)
59-60: Whitespace cleanup around verification section.The modification of lines 59–60 aligns with the PR objective of normalizing whitespace and removing trailing spaces in the "Verify integrity" section.
258-258: EOF newline properly added.Line 258 shows the addition of a trailing newline at end-of-file, addressing file termination linting requirements.
docs/admin/admin-ui/logs.md (1)
11-11: Formatting improvements approved.The wording refinements and blank line additions in this file improve clarity and readability. No markdown linting violations detected.
Also applies to: 38-40
docs/admin/kubernetes-ops/README.md (1)
32-32: List formatting looks good.The addition of the Memory Dump link maintains consistent formatting with the surrounding list items.
docs/install/README.md (1)
48-49: Paragraph spacing improvement approved.The added blank line at line 49 improves readability by providing better visual separation in the Optimization section.
docs/openbanking/index.md (1)
5-5: Trailing space removal approved.The elimination of trailing spaces on line 5 directly addresses the PR objective of fixing linting issues.
docs/install/helm-install/google-gke.md (1)
26-30: Fix duplicate ordered list numbering: steps are numbered 3, 3, 4, 5, 6 instead of 3, 4, 5, 6, 7.The file contains two items numbered "3": one at line 25 ("If you are using Cloud Shell...") and another at line 27 ("Install gcloud..."). The second should be numbered "4", and subsequent steps should increment accordingly. This creates a markdown list structure error that linting tools will flag.
docs/admin/README.md (1)
13-13: Approved: Proper EOF newline added.The addition of a trailing newline at the end of the file aligns with standard documentation formatting. ✓
docs/admin/admin-ui/user-claims.md (1)
18-80: Documentation formatting improvements approved.The changes improve visual hierarchy and readability through strategic blank line placement, consistent punctuation, and reformatted field descriptions. No semantic or instructional changes detected.
docs/reference/kubernetes/docker-flex-monolith.md (2)
12-12: Correct: Removed leading space before admonition.Markdown admonitions should not have leading spaces; this fix aligns with standard formatting rules.
71-71: Correct: Removed leading space before section heading.Markdown section text should not have unnecessary leading spaces; this fix improves readability and conforms to formatting standards.
automation/rancher-partner-charts/pull_request_body.md (1)
7-7: Approved: Normalized spacing between sentences.Changed double space to single space before "We" — aligns with standard English punctuation conventions.
docs/openbanking/install-cn.md (1)
5-120: Documentation formatting improvements approved.Changes involve strategic blank line insertion and indentation refinements throughout structured sections (tables, lists, code blocks). These improve readability and visual hierarchy without altering content, instructions, or system behavior.
docs/admin/admin-ui/auth-server-menu.md (1)
16-17: Approved: Sentence reflow for improved line wrapping.Content remains unchanged; the sentence is merely reflow for better readability in rendered markdown.
docker-flex-monolith/README.md (1)
70-70: Correct: Removed leading space before section heading.Markdown section text should not have leading spaces; this fix improves formatting consistency.
docs/admin/admin-ui/saml-menu.md (1)
40-74: Unresolved ordered list numbering issues per markdownlint (MD029).The static analysis indicates that items 11 and 12 in the "Create Identity Provider (IDP) Form" section have incorrect prefixes (expected 7 and 8, respectively). This suggests the list items should be renumbered starting from 1 rather than 5 to maintain sequential markdown list formatting.
Additionally, while your PR description focuses on fixing trailing spaces and EOF newlines, line 57 adds new explanatory content ("Gluu Flex will send SAML AuthnRequests to this URL to initiate login."), which extends beyond formatting fixes. Please confirm if this content addition is intentional.
docs/openbanking/configuration-instructions.md (1)
1-19: Unresolved markdownlint error (MD041): missing top-level heading.The file begins with a level-2 heading (
##) on line 1, but markdownlint (MD041) requires files to start with a top-level heading (#). If this is a standalone documentation file, you should add a top-level heading before line 1. If this file is intended to be included as a subsection within another document, please clarify the intended structure.docs/admin/admin-ui/auth-server-interaction.md (1)
153-155: Formatting-only adjustments look good.The trailing newline adjustment to the Conclusion section is a clean formatting fix with no impact on content or semantics.
docs/install/docker-install/compose.md (1)
1-23: Unresolved markdownlint error (MD041): missing top-level heading before content.Line 11's warning admonition is the first content block after the YAML frontmatter, but markdownlint (MD041) requires the first content line to be a top-level heading (
#). The file's main heading "# Docker Compose" appears later at line 14. Consider moving the# Docker Composeheading to line 11 (immediately after the frontmatter) and then placing the warning admonition after it.docs/install/helm-install/rancher.md (1)
16-18: Unresolved grammar issue: missing hyphen in compound adjective.Line 17 contains "single node deployment" which should be hyphenated as "single-node deployment" when used as a compound adjective before a noun (per LanguageTool grammar check QB_NEW_EN_HYPHEN). While your PR aims to fix linting issues, this grammar correction appears to have been missed.
🔎 Proposed fix
- If you are deploying an Ingress controller on a single node deployment, in which Ingress utilizes ports 80 and 443, then you have to adjust the host ports mapped for the rancher/rancher container. + If you are deploying an Ingress controller on a single-node deployment, in which Ingress utilizes ports 80 and 443, then you have to adjust the host ports mapped for the rancher/rancher container.docs/install/docker-install/quick-start.md (1)
9-59: Formatting adjustments look good.The whitespace refinements around the warning admonition and content restructuring maintain document readability without altering content or introducing issues.
docs/admin/admin-ui/introduction.md (1)
15-25: Grammatical improvement and formatting adjustment look good.The change from "depending components" to "dependent components" (line 15) correctly fixes the grammar - "dependent" is the proper descriptor for components with dependencies. The whitespace restructuring in the Admin UI Backend section (line 25) maintains clarity without changing semantics.
docs/README.md (1)
33-42: Content addition goes beyond PR scope.Your PR description states the goal is to "fix documentation formatting by removing extra newlines and trailing spaces." However, lines 34-42 add a new subsection "Testing Documentation Changes Locally" with approximately 9 lines of new instructional content. While this addition is useful, it represents a significant content change that extends beyond formatting and linting fixes.
Please clarify if this content addition is intentional or if it should be separated into a different PR focused on documentation improvements.
docs/admin/admin-ui/configuration.md (1)
78-80: Trailing whitespace cleanup aligns with PR objective.The removal of trailing spaces in the table cell and section reorganization are appropriate formatting fixes.
docs/admin/admin-ui/fido-menu.md (1)
41-41: Whitespace normalization improves markdown consistency.Blank line adjustments around definition lists and bullet sections maintain proper markdown structure and improve readability. Changes align with the PR's formatting objective.
Also applies to: 82-82, 96-96, 135-135, 165-165
docs/openbanking/install-vm.md (1)
20-26: Text reflow and newline adjustments are appropriate for readability.Paragraph reflow and blank line normalization improve markdown structure. The changes align with the PR objective of whitespace cleanup. However, note the static analysis warnings below.
Note on static analysis warnings:
- MD007 (line 22): List indentation warning. Per repository learnings, 4-space indentation for nested lists is intentional in GluuFederation/flex documentation and may safely trigger this warning.
- MD046 (line 115): Code block style expects indented format but uses fenced (the
!!!Noteadmonition syntax). This appears intentional for proper markdown-it admonition rendering and should not be changed.Verify that these warnings are acceptable in the repository's linting configuration.
Also applies to: 60-61, 68-69, 111-116, 129-129
README.md (1)
70-71: Line breaks improve paragraph readability without semantic changes.Sentence reflow in the licensing and SSA description sections enhances readability while preserving all content and meaning. Changes align with the PR's formatting objective.
Also applies to: 75-78
docs/admin/admin-ui/webhooks.md (1)
14-14: Heading, grammar, and line-break improvements enhance clarity.The changes include a necessary grammar correction ("consists for" → "consists of") and line-break adjustments that improve readability. While the grammar fix exceeds pure whitespace cleanup, it is a minimal, non-breaking documentation improvement.
Also applies to: 16-16, 32-32, 80-80
docs/admin/admin-ui/scim-menu.md (3)
10-23: Line breaks and text reflow improve organization and readability.Paragraph reflow throughout the file maintains all content while improving visual structure and flow. Changes align with documentation formatting improvements.
Also applies to: 69-70
27-27: New subsection heading represents intentional documentation restructuring.The addition of "### More details about important properties" represents a beneficial structural improvement that goes slightly beyond the stated PR objective (trailing spaces and EOF newlines) but enhances documentation clarity by explicitly grouping property definitions.
Verify this structural addition aligns with the maintainers' documentation organization strategy.
48-48: Blank line normalization.Whitespace adjustment maintains proper spacing around definition lists.
docs/openbanking/jans-cli.md (2)
6-8: Text reflow and section restructuring improve readability.Paragraph reflow and blank line adjustments maintain content while improving organization. Additions to the Supported Operations section (documentation of
put-config-scriptsand expandedget-config-scripts-by-typedetails) represent beneficial operational documentation updates.Also applies to: 45-45, 51-59, 125-138, 150-163
155-155: Verify resolution of trailing space on line 155.Static analysis tool markdownlint-cli2 flagged line 155 as having trailing spaces (expected: 0 or 2; actual: 1). Please confirm this has been addressed in the actual file, as the annotated code does not visually show whitespace characters.
docs/install/helm-install/microsoft-azure.md (1)
27-27: Formatting improvements are appropriate.The blank-line adjustments around code blocks and sections improve readability and consistency with standard markdown spacing conventions. These changes align with the PR's formatting objectives.
Also applies to: 50-50, 108-108, 187-187
docs/install/helm-install/README.md (1)
20-20: Formatting refinements improve consistency.Consolidating the paragraph on line 20 and normalizing the trailing newline after the code block on line 33 align with the PR's formatting objectives.
Also applies to: 33-33
docs/install/helm-install/amazon-eks.md (1)
25-25: Whitespace adjustments enhance readability.The blank-line additions around code blocks and between sections are appropriate formatting improvements consistent with markdown conventions.
Also applies to: 48-48, 110-110, 187-187
docs/install/helm-install/local.md (2)
51-51: Link reference is more explicit.Updating the link from a relative reference to the full GitHub path (
charts/gluu/values.yaml) provides clearer navigation for readers. This improves the documentation's helpfulness.
63-65: Formatting consolidation improves section clarity.Removing the bullet marker and consolidating the TUI configuration note into a continuous paragraph (with proper blank-line separation) aligns with the PR's formatting objectives.
Signed-off-by: ossdhaval <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/admin/recipes/testing-flex-saml-sso-sptest.md (1)
52-54: Add language specification to the IDP metadata URL code block.This code block lacks a language specification, which may trigger MD040 linting errors (consistent with the fixes applied to other code blocks in this PR).
🔎 Proposed fix
* Download the IDP metadata from the following URL: - ``` + ```bash https://<your-janssen-server>/kc/realms/jans/protocol/saml/descriptor</details> </blockquote></details> <details> <summary>docs/openbanking/jans-cli.md (1)</summary><blockquote> `1-168`: **Remove trailing whitespace from 8 lines** Trailing spaces remain on lines 14, 15, 24, 30, 31, 46, 57, and 156. These must be removed to pass linting checks. The file correctly ends with a single newline. </blockquote></details> </blockquote></details>♻️ Duplicate comments (5)
docs/admin/admin-ui/faq.md (1)
44-44: Fix double "is" in heading questions.Both lines 44 and 50 contain a grammatical error with redundant verb forms. The phrasing "the Gluu Flex Admin UI is displaying" creates a double subject-verb construction within the question.
Correct to either "the Gluu Flex Admin UI displaying" (keeping the outer "is") or restructure the question entirely.
🔎 Proposed fix
- ### Why is the Gluu Flex Admin UI is displaying the following page to upload SSA? + ### Why is the Gluu Flex Admin UI displaying the following page to upload SSA?- ### Why is the Gluu Flex Admin UI is displaying the following message on screen to generate trial license? + ### Why is the Gluu Flex Admin UI displaying the following message on screen to generate trial license?Note: This appears related to the previous review feedback mentioning the missing article "the," but the root issue is the doubled verb form.
Also applies to: 50-50
docs/openbanking/jans-cli.md (1)
3-3: Fix applied for hyphenated compound adjective.Line 3 now correctly uses "command-line interface" (hyphenated) matching the existing "command-line options" in the same sentence. This addresses the previous grammar feedback.
docs/solo/solo-subscription.md (1)
11-13: LanguageTool lint issue addressed.The wording has been updated from the verbose "in order to avail" to the more concise "to access," which addresses the prior LanguageTool (IN_ORDER_TO_PREMIUM) lint flag. The phrasing is now clearer and more direct.
— This issue was flagged in a prior review and has now been resolved.
docs/solo/solo-administration-guide.md (1)
20-20: Images now have alt text; consider more descriptive descriptions.The images at lines 20, 54, and 61 now have alt text added (addressing the previous MD045 lint error). However, the alt text is minimal—just filenames like "solo-configuration" and "solo-settings-page". While this satisfies the markdownlint requirement, more descriptive alt text would improve accessibility and SEO (e.g., "Gluu Solo configuration page" instead of "solo-configuration").
— This concern was flagged in a prior review.
— The lint error (MD045) has been addressed.🔎 Example improvement for line 20
- +Similarly, consider:
- Line 54:
![solo-settings-page]→![Gluu Solo settings page]- Line 61:
![solo-billing-page]→![Gluu Solo billing page]Also applies to: 54-54, 61-61
automation/rancher-partner-charts/app-readme.md (1)
18-18: Unresolved compound adjective issue in heading.The heading still uses "Free Open Source Software" but should use the hyphenated form "Free Open-Source Software" to comply with grammar and the EN_COMPOUND_ADJECTIVE linting rule (flagged by LanguageTool). This issue was noted in the previous review and remains outstanding.
🔎 Proposed fix
-### Free Open Source Software +### Free Open-Source Software📜 Review details
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (12)
automation/rancher-partner-charts/app-readme.mddocs/admin/admin-ui/faq.mddocs/admin/admin-ui/scripts.mddocs/admin/admin-ui/user-management-menu.mddocs/admin/kubernetes-ops/admin-ui-private.mddocs/admin/recipes/getting-started-rancher.mddocs/admin/recipes/testing-flex-saml-sso-sptest.mddocs/install/vm-install/suse.mddocs/openbanking/jans-cli.mddocs/openbanking/par-jarm.mddocs/solo/solo-administration-guide.mddocs/solo/solo-subscription.md🧰 Additional context used
🧠 Learnings (2)
📓 Common 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.📚 Learning: 2025-11-17T12:38:43.830Z
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.Applied to files:
docs/admin/recipes/getting-started-rancher.mddocs/install/vm-install/suse.mdautomation/rancher-partner-charts/app-readme.md🪛 LanguageTool
automation/rancher-partner-charts/app-readme.md
[uncategorized] ~18-~18: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... - Identity federation ### Free Open Source Software The Gluu Server is a FOSS pla...(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.18.1)
docs/admin/admin-ui/scripts.md
28-28: Trailing spaces
Expected: 0 or 2; Actual: 4(MD009, no-trailing-spaces)
29-29: Trailing spaces
Expected: 0 or 2; Actual: 4(MD009, no-trailing-spaces)
docs/admin/recipes/testing-flex-saml-sso-sptest.md
79-79: Spaces inside code span elements
(MD038, no-space-in-code)
docs/admin/admin-ui/user-management-menu.md
43-43: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
🔇 Additional comments (18)
docs/admin/kubernetes-ops/admin-ui-private.md (2)
93-95: ✅ MD040 violations resolved—language specifiers added to code blocks.The previous review flagged that the fenced code blocks at lines 93–95 and 101–103 were missing language specifications, causing MD040 linting failures. This PR correctly adds
shlanguage specifiers to both blocks, resolving those violations.Also applies to: 101-103
50-107: Whitespace cleanup and formatting adjustments are appropriate.The removal of extra blank lines at lines 54, 64, 70, and 88 aligns with the PR objective to fix linting issues. The content, structure, and semantic meaning of the documentation remain unchanged; only formatting is adjusted.
docs/admin/admin-ui/faq.md (1)
32-32: Content changes look good.The edits to the section heading (line 32) and the trial license expiration note (line 64) are clear and well-formatted.
Also applies to: 64-64
docs/openbanking/par-jarm.md (3)
10-12: Blank line after heading correctly addresses past MD022 linting issue.The blank line added at line 11 (marked with
~) properly resolves the MD022 rule violation flagged in the previous review comment. The heading at line 10 now has the required blank line before the paragraph begins at line 12.
33-35: Blank line after second heading maintains consistent MD022 compliance.The blank line at line 34 (marked with
~) ensures the second heading also complies with MD022 by providing the required blank line before the paragraph at line 35.
3-4: Verify text reflow is limited to linting fixes scope.Lines 3–4, 35–37, and 40 show text content changes marked with
~. While these could represent trailing space removal or legitimate paragraph rewrapping, confirm that these modifications are limited to fixing linting issues (trailing spaces, line wrapping) rather than substantive content edits, to stay within the stated PR scope of "fix linting issues."Also applies to: 35-37, 40-40
docs/admin/recipes/testing-flex-saml-sso-sptest.md (3)
12-14: Paragraph reflow changes look good.Whitespace-only adjustments maintain content and readability. No issues identified.
Also applies to: 18-20, 26-27, 48-49
30-32: Code block formatting is correct.The bash language specification and surrounding blank lines properly address MD031 and MD040 linting requirements.
75-85: Resolve lingering MD038 linting warning on code block at line 79.The changes to the FAQ section correctly address the previous MD031 (blank lines) and MD040 (language specs) issues flagged in prior review. However, static analysis still reports an MD038 violation (spaces inside code span elements) on line 79, which may indicate trailing or leading spaces within the code block content or markdown syntax.
Please verify that line 79 has no extraneous whitespace inside or around the code span. If the issue persists after visual inspection, check for hidden trailing spaces or malformed markdown syntax and remove them to fully resolve the linting warnings.
docs/admin/admin-ui/scripts.md (1)
31-32: Verify no trailing spaces on reflowed custom properties text.Lines 31–32 have been reflowed similarly to lines 28–29. Ensure that these lines also do not have trailing spaces that would violate the MD009 linting rule.
docs/install/vm-install/suse.md (3)
116-121: Correctly resolves prior MD022 heading spacing issue.The blank lines now properly surround the "## Enabling HTTPS" heading, fixing the markdown lint error that was flagged in the previous review. The structure (blank line → heading → blank line) follows MD022 requirements.
94-94: Heading spacing is consistent and MD022-compliant throughout.All section headings are now properly surrounded by blank lines per markdown lint rules. The spacing adjustments are consistent across the document (lines 94, 138–139, and 207).
Also applies to: 138-139, 207-207
59-59: Minor text adjustments maintain readability and clarity.The punctuation and wording changes (line 59, 253) are consistent with documentation best practices and do not alter the functional meaning of instructions.
Also applies to: 253-253
docs/solo/solo-administration-guide.md (1)
13-14: Text reflow changes look correct.The formatting adjustments and line-wrapping changes across these segments are syntactically sound and preserve the original meaning and structure. No issues detected.
Also applies to: 16-18, 22-23, 26-26, 39-40, 45-47, 51-52
docs/solo/solo-subscription.md (1)
15-15: Text reflow correct.The line-wrapping adjustment preserves meaning and formatting. No issues detected.
automation/rancher-partner-charts/app-readme.md (1)
6-6: Markdown structure improvements approved.The blank lines added around headings (lines 6, 23, 34, 38) properly address the MD022 linting rule (headings must be surrounded by blank lines). The formatting improvements enhance readability and resolve the spacing violations.
Also applies to: 23-23, 34-34, 38-38
docs/admin/recipes/getting-started-rancher.md (2)
1-3: Top-level heading structure fixes MD041 linting issue.The addition of the H1 heading "# Gluu Flex on SUSE Rancher" at the file's start resolves the MD041 requirement (first line in file should be a top-level heading). This aligns with the pattern established in peer documentation files and improves document structure.
212-212: Whitespace and formatting consistency applied throughout.Multiple sections have been refined with improved spacing and punctuation consistency:
- Blank lines added/adjusted around major sections for clarity (Installation, Connecting to Setup, Enabling Two-Factor Authentication, etc.)
- Minor text refinements for grammatical clarity (e.g., "Click on the" → proper phrasing)
- Table and code block formatting preserved appropriately
These changes enhance document readability without altering technical content or instructions.
Also applies to: 218-218, 221-221, 240-241, 301-301, 233-233, 288-288
Signed-off-by: ossdhaval <[email protected]>
Fixes documentation formatting by removing extra newlines and trailing spaces.
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.