fix(docs): fix linting issues - trailing spaces and EOF newline by ossdhaval · Pull Request #12843 · JanssenProject/jans (original) (raw)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d11d32f and 1c31fb7.

📒 Files selected for processing (50) 

Learnt from: yuriyz
Repo: JanssenProject/jans PR: 12596
File: docs/janssen-server/auth-server/tokens/oauth-tx-tokens.md:146-257
Timestamp: 2025-11-19T12:55:01.596Z
Learning: In the Janssen project, the TxToken custom script documentation is intentionally duplicated in both `docs/janssen-server/auth-server/tokens/oauth-tx-tokens.md` and `docs/script-catalog/tx_token/txtoken.md` to provide easy access from both the transaction token documentation and the script catalog.

Applied to files:

Learnt from: iromli
Repo: JanssenProject/jans PR: 12771
File: docs/casa/administration/quick-start.md:59-78
Timestamp: 2025-11-26T21:39:24.942Z
Learning: In Kubernetes Helm deployments, running `helm upgrade` or `helm install` automatically triggers a rollout/restart of pods when ConfigMap or environment variable values change. A separate manual restart step (e.g., `kubectl rollout restart`) is not necessary.

Applied to files:

Learnt from: misba7
Repo: JanssenProject/jans PR: 12737
File: automation/mysql.yaml:22-59
Timestamp: 2025-11-26T12:38:52.165Z
Learning: In the Janssen project, Kubernetes manifests in the automation/ directory (such as mysql.yaml and pgsql.yaml) are for demo and testing purposes only. These manifests do not require production-level hardening (security contexts, resource limits, health checks, etc.) as they are intended for local development and demonstration scenarios, not production deployments.

Applied to files:

Learnt from: pujavs
Repo: JanssenProject/jans PR: 12704
File: jans-config-api/docs/jans-config-api-swagger.yaml:17540-17546
Timestamp: 2025-11-18T07:43:55.761Z
Learning: The file `jans-config-api/docs/jans-config-api-swagger.yaml` is auto-generated with dependent modules changes and metadata. The config API does not override it.

Applied to files:

Learnt from: ossdhaval
Repo: JanssenProject/jans PR: 12539
File: docs/janssen-server/auth-server/client-management/software-statements.md:29-29
Timestamp: 2025-10-30T15:21:12.720Z
Learning: In the Janssen Project documentation (docs/ directory), relative links in markdown files work correctly when tested locally even when intermediate directory segments like "janssen-server" appear to be missing from the relative path. The documentation build system handles path resolution appropriately, so local testing by developers is authoritative for verifying link correctness.

Applied to files:

Learnt from: CR
Repo: JanssenProject/jans PR: 0
File: jans-cedarling/AGENTS.md:0-0
Timestamp: 2025-12-10T08:24:27.240Z
Learning: Applies to jans-cedarling/**/*.rs : Keep documentation concise, focusing on explanatory content rather than obvious details

Applied to files:

Learnt from: CR
Repo: JanssenProject/jans PR: 0
File: jans-cedarling/AGENTS.md:0-0
Timestamp: 2025-12-10T08:24:27.240Z
Learning: Generate and view documentation with `cargo doc -p cedarling --no-deps --open`

Applied to files:

Learnt from: CR
Repo: JanssenProject/jans PR: 0
File: jans-cedarling/AGENTS.md:0-0
Timestamp: 2025-12-10T08:24:27.240Z
Learning: Applies to jans-cedarling/**/*.rs : Document public API items with docstrings focusing on 'why' not 'what'

Applied to files:

Learnt from: CR
Repo: JanssenProject/jans PR: 0
File: jans-cedarling/AGENTS.md:0-0
Timestamp: 2025-12-10T08:24:27.240Z
Learning: Applies to jans-cedarling/**/*.rs : Use standard Rust docstrings without Python-style sections (avoid `# Arguments`, `# Returns`)

Applied to files:

Learnt from: CR
Repo: JanssenProject/jans PR: 0
File: jans-cedarling/AGENTS.md:0-0
Timestamp: 2025-12-10T08:24:27.240Z
Learning: Applies to jans-cedarling/**/*.rs : Each Rust file must contain the Apache 2.0 license header with copyright attribution to Gluu, Inc.

Applied to files:

Learnt from: olehbozhok
Repo: JanssenProject/jans PR: 12768
File: jans-cedarling/cedarling/src/common/default_entities_limits.rs:52-119
Timestamp: 2025-12-01T00:02:51.580Z
Learning: In the jans-cedarling Rust codebase, avoid Python/Java-style doc comments with explicit `# Arguments` and `# Errors` sections. The project relies on Rust's type signatures and cargo doc's automatic documentation generation.

Applied to files:

Learnt from: CR
Repo: JanssenProject/jans PR: 0
File: jans-cedarling/AGENTS.md:0-0
Timestamp: 2025-12-10T08:24:27.240Z
Learning: Applies to jans-cedarling/**/*.rs : Review clippy.toml for project-specific lint rules

Applied to files:

[style] ~28-~28: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ul, an empty key file is generated. If no mounted or downloaded files are foun...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

[style] ~121-~121: Using many exclamation marks might seem excessive (in this case: 12 exclamation marks for a text that’s 1672 characters long)
Context: ...n ``` ## Auth-server !!! Warning key rotation CronJob is usu...

(EN_EXCESSIVE_EXCLAMATION)

docs/janssen-server/planning/kubernetes.md

[grammar] ~38-~38: Use a hyphen to join words.
Context: ...them is much more as compared to a cloud native deployment and it is error-prone....

(QB_NEW_EN_HYPHEN)

[style] ~42-~42: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...th but taking the above into account is very important. ## The Supported Clouds We support s...

(EN_WEAK_ADJECTIVE)

[style] ~61-~61: In American English, abbreviations like “etc.” require a period.
Context: ...such as Jenkins, Ansible, Cloud Build ..etc

(ETC_PERIOD)

docs/janssen-server/planning/benchmarking.md

[grammar] ~42-~42: Use a hyphen to join words.
Context: ...re you look at both short tests and long running tests. A slow memory leak may on...

(QB_NEW_EN_HYPHEN)

🪛 markdownlint-cli2 (0.18.1) docs/janssen-server/recipes/ACRouter.md

43-43: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

docs/janssen-server/kubernetes-ops/cert-management.md

55-55: Trailing spaces
Expected: 0 or 2; Actual: 8

(MD009, no-trailing-spaces)

56-56: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

58-58: Trailing spaces
Expected: 0 or 2; Actual: 12

(MD009, no-trailing-spaces)

66-66: Trailing spaces
Expected: 0 or 2; Actual: 12

(MD009, no-trailing-spaces)

docs/janssen-server/recipes/stepped-up-authn.md

13-13: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

13-13: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

50-50: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

docs/janssen-server/planning/passwordless-auth.md (1)

31-31: ✓ Linting fix approved.

Trailing whitespace removal on line 31 aligns with the PR objective and introduces no semantic changes. The documentation content is unaffected.

docs/janssen-server/kubernetes-ops/backup-restore.md (1)

70-70: LGTM – Linting fix approved.

The change correctly addresses the EOF newline issue as indicated by the PR objective. The markdown structure is valid, all code blocks are properly formatted, and no semantic content was inadvertently modified. This is a clean documentation maintenance fix.

docs/janssen-server/kubernetes-ops/customization.md (2)

103-103: Verify markdown blank line spacing between list sections.

Lines 103 and 135 mark blank lines between numbered list items and subsequent sections. Per markdown best practices, blank lines between list items and new content (headings, code blocks) ensure proper parsing. These changes appear correct for maintaining markdown structure compliance.

Also applies to: 135-135

404-404: EOF newline addition aligns with markdown linting standards.

Adding a newline at end-of-file is a standard linting requirement for markdown and text files. This change is appropriate.

docs/janssen-server/lock/lock-server.md (2)

590-590: Linting fixes look appropriate for this PR.

The formatting changes at lines 590 and 692 align with the PR objective to address markdown lint issues. The removal of bullet formatting from "Causes:" and the adjustment to the final "See Also" reference maintain content integrity while improving lint compliance.

Also applies to: 692-692

684-684: Verify relative links remain valid after formatting changes.

The file contains several relative markdown links (e.g., ./README.md, ../../cedarling/README.md, ../auth-server/oauth-features/README.md, ../config-guide/config-tools/jans-cli/README.md). Confirm these resolve correctly after the linting fixes. Based on learnings, relative links in Janssen Project documentation resolve properly when tested locally, so this should be low-risk.

Also applies to: 688-692

docs/janssen-server/keycloak/keycloak-saml-sso.md (1)

90-91: Summary-to-code inconsistency: verify actual content changes.

The AI summary states that "cached session conflicts" was replaced with "session issue," but the provided code still shows "cached session conflicts." Please verify whether content wording changes were actually applied or if the summary is inaccurate. This is important to confirm scope: the PR title indicates linting fixes only (trailing spaces, EOF newline), but the summary suggests content modifications that go beyond linting.

docs/janssen-server/keycloak/keycloak-saml-inbound.md (1)

47-49: Scope clarification needed: content change beyond linting.

Line 49 shows a content change (removal of "Use" from the beginning of "Agama Lab is an online visual editor..."), which goes beyond the stated PR objective of fixing linting issues (trailing spaces and EOF newlines). Line 47 appears to be a legitimate trailing space removal from the header. Please clarify whether these content modifications are intentional or if they should be reverted to keep changes scoped to linting only.

docs/janssen-server/planning/role-based-access-management.md (2)

1-39: Procedural concern: PR checklist incomplete.

The PR objectives indicate that the testing/documentation checklist items are unchecked. For a documentation-only fix PR, at minimum ensure:

  • Markdown linting passes (trailing spaces removed, EOF newline present)
  • No unintended formatting changes that alter meaning
  • All affected documentation files compile/render correctly

Consider completing the checklist before merge, or clarify which items are not applicable.

30-31: The changes to this file are correct — no linting issues present.

Lines 30-31 contain no trailing whitespace, the file properly ends with a newline, and the line break preserves natural semantic flow ("authenticates using a web browser"). No changes needed.

docs/janssen-server/planning/vm-cluster.md (2)

10-11: Formatting adjustment is appropriate.

The Note section reformatting aligns with the PR objective to fix linting issues related to line formatting and spacing.

13-16: Content addition is clear and well-integrated.

The new paragraph appropriately sets context for the planning guide and maintains consistency with the document's purpose.

docs/janssen-server/planning/kubernetes.md (1)

37-40: Content changes beyond stated linting scope.

These lines contain rewording of the HA guidance that appears to exceed the PR's stated objective to fix only linting issues (trailing spaces and EOF newlines). The reworded content clarifies that VM clusters can provide HA but still recommends against it, and adds information about helm upgrades. Please clarify if these content modifications are within the intended scope of this PR.

docs/janssen-server/kubernetes-ops/logs.md (2)

88-88: Confirm heading format changes align with markdown lint standards.

The formatting on these lines appears to have changed from list-item style (with dash prefix) to plain paragraph text headings. Confirm that:

  1. This change is intentional and aligns with the document's markdown linting rules
  2. The visual rendering in the generated documentation remains clear and consistent
  3. The semantic meaning of these sections is preserved

Also applies to: 143-143, 193-193, 248-248, 265-265

21-28: Verify trailing space cleanup on line 22 of the Log Levels table.

Trailing spaces trigger linting violations and should be removed from the end of lines. While markdown table formatting is flexible with spacing as long as there are at least three dashes per column, the table separator on line 22 should have no trailing whitespace to pass linting checks. Confirm that all trailing spaces have been removed from both the header and separator rows, and verify EOF newline is present.

docs/janssen-server/install/helm-install/microsoft-azure.md (2)

25-33: Verify completeness of trailing space removal.

Several lines in this section appear to have trailing whitespace visible (e.g., line 29 after --generate-ssh-keys, line 33) but are not marked as changed. Please confirm whether these are intended to be addressed by this PR, or whether the visible trailing spaces in the provided code block are artifacts of the display format.

183-184: Formatting adjustment at Configure Janssen section looks appropriate.

The blank line and indentation adjustment here aligns with the documentation formatting cleanup objective.

docs/janssen-server/planning/components.md (1)

77-80: EOF newline addition is correct.

Adding the missing trailing newline after the final sentence complies with markdown linting standards and documentation best practices.

docs/janssen-server/install/helm-install/rancher.md (2)

19-21: Trailing space normalization in note block is appropriate.

The adjustment to the Ingress note formatting aligns with the PR's linting cleanup objective.

40-42: Trailing space removal in Step 12 description is appropriate.

Formatting normalization in the installation step aligns with documentation cleanup goals.

docs/janssen-server/recipes/api-access-control/oauth-api-gateway.md (1)

16-18: Content change (removing "in the meantime") extends beyond linting scope.

While the simplification improves the contribution prompt, this is a content change beyond trailing spaces and EOF newlines mentioned in the PR title. Ensure this change is intentionally applied across similar documentation files for consistency.

docs/janssen-server/recipes/custom-web-development/angular.md (1)

16-18: Content simplification is consistent with other recipe files.

The removal of "in the meantime" from the contribution prompt aligns with the same change applied across the documentation set. The simplification makes the prompt more direct and actionable.

docs/janssen-server/planning/use-cases.md (2)

77-92: Removal of leading hyphen in Mobile Authentication section improves formatting.

Removing the unnecessary list marker from the "example, using the OAuth..." sentence maintains paragraph flow and corrects formatting inconsistency.

124-147: Trailing space removal in Authorization section is appropriate.

The formatting normalization aligns with the PR's linting cleanup objectives.

docs/janssen-server/recipes/benchmark.md (6)

15-19: Blank line addition in note block improves formatting.

The spacing adjustment around the note content enhances readability and maintains consistent formatting with markdown standards.

54-55: Blank line insertion for section separation is appropriate.

Adding spacing before the "Load-test" section improves visual hierarchy and document flow.

205-206: Blank line addition after user loading instructions is appropriate.

The spacing improves section separation and readability between major procedural steps.

299-300: Blank line addition before load test scaling instructions is appropriate.

Spacing improves the visual structure and separates procedural steps logically.

389-390: Blank line addition for ROPC flow section is appropriate.

Consistent formatting with Authorization code flow section improves document consistency.

491-492: Blank line addition for DCR flow section is appropriate.

Consistent spacing maintains visual hierarchy across similar procedural sections.

docs/janssen-server/install/helm-install/google-gke.md (2)

19-27: Blank line additions in Initial Setup section improve readability.

The spacing after gcloud and kubectl installation steps provides better visual separation and follows consistent formatting patterns with other helm installation guides.

178-180: Configure Janssen section formatting appears consistent.

The spacing and formatting align with patterns established in other helm installation guides (microsoft-azure.md, google-gke.md).

docs/janssen-server/install/vm-install/rhel.md (1)

1-188: LGTM!

Documentation formatting and linting fixes applied correctly. No functional changes to content.

docs/janssen-server/recipes/ACRouter.md (1)

43-44: Verify that MD022 linting error is resolved.

Static analysis flagged a markdown linting issue on line 43: "Headings should be surrounded by blank lines (MD022)." The file structure shows a blank line before the heading (line 42), which should satisfy the rule. Please confirm that this linting error has been resolved by the changes, or clarify if additional formatting adjustments are needed.

docs/janssen-server/recipes/inbound-oidc.md (1)

139-145: LGTM!

Spacing between code block and section heading adjusted correctly. Formatting change aligns with linting standards.

docs/janssen-server/link/README.md (1)

26-28: Clarify scope: PR title mentions linting fixes, but file includes content consolidation.

The contribution guidance section has been consolidated from multiple lines into a single sentence. While this improves readability, it represents a content change beyond the stated scope of fixing trailing spaces and EOF newlines. Please confirm whether this consolidation was intentional and part of the PR's scope.

docs/janssen-server/link/jans-keycloak-link.md (2)

14-14: LGTM!

Removal of leading whitespace on line 14 aligns with linting standards for documentation files.

101-103: Contribution guidance updated consistently across documentation.

The "Want to contribute?" section has been simplified to a single line, aligning with similar updates across other documentation files in this PR. This represents standardized contribution guidance wording.

docs/janssen-server/recipes/returning-group.md (1)

15-17: LGTM!

Contribution guidance simplified consistently with other documentation files in this PR. Wording now directly references the Contribution guide without temporal qualifiers.

docs/janssen-server/developer/cors.md (1)

13-15: Scope clarification: PR adds new behavioral documentation beyond linting fixes.

Lines 14-15 introduce explicit documentation about HTTP 403 (Forbidden) error handling for invalid CORS requests. While this information appears technically accurate and valuable, it represents new content beyond the stated scope of fixing trailing spaces and EOF newlines. Please confirm whether this documentation enhancement was intentional.

docs/janssen-server/install/helm-install/red-hat-open-shift.md (1)

16-18: LGTM!

Contribution guidance simplified and standardized with other documentation files. Removes "in the meantime" phrasing for more direct community engagement messaging.

docs/janssen-server/install/vm-install/ubuntu.md (2)

104-104: Verify the formatting change to the "Or," line.

Removing the bullet marker from "Or," (line 104) changes it from a list item to plain text, which creates inconsistent formatting. The line appears to introduce an alternative installation method using dpkg, which semantically should remain a list item.

This change may introduce a markdown rendering inconsistency. Please verify whether this was intentional or should be reverted to maintain consistency with the surrounding list structure.

182-182: EOF newline cleanup approved.

Removing the trailing blank line after the Let's Encrypt section aligns with the PR objective to fix trailing whitespace and EOF newline issues.

docs/janssen-server/install/vm-install/disa-stig.md (1)

20-20: Wording improvement approved.

Removing "in the meantime" from the contribution prompt improves clarity and reduces redundancy with the earlier "Have questions in the meantime?" section heading.

docs/janssen-server/recipes/locking-accounts.md (1)

19-19: Wording standardization approved.

Removing "in the meantime" aligns with broader documentation standardization effort visible across multiple files in this PR.

docs/janssen-server/install/helm-install/README.md (2)

21-21: Wording adjustment approved.

The change improves clarity in the sentence about version retention policy.

34-34: EOF newline cleanup approved.

Adding the trailing newline after the code fence aligns with the PR objective to fix EOF newline issues.

docs/janssen-server/install/helm-install/local.md (1)

47-47: Minor wording refinement approved.

The adjustment improves readability of the installation step description.

docs/janssen-server/recipes/stepped-up-authn.md (1)

21-48: Mermaid diagram formatting approved.

The sequence diagram blocks are properly formatted with titles and content.

docs/janssen-server/link/jans-link.md (2)

10-11: Text rewrapping and formatting improvements approved.

The line rewrapping improves readability while maintaining the same semantic content. No functional changes detected.

Also applies to: 15-17, 25-26, 28-28, 34-34, 40-40

236-241: Section heading and wording refinements approved.

Text adjustments enhance clarity and consistency in command descriptions and configuration explanations. Per retrieved learnings, link adjustments are verified through local testing and are safe.

Also applies to: 243-247, 287-287, 313-313, 317-321, 346-351

docs/janssen-server/recipes/casa.md (2)

23-23: Trailing space cleanup approved.

Removal of trailing spaces aligns with PR objectives for linting issue fixes.

Also applies to: 35-35, 40-40

41-64: New automated installation section added.

A new "Automate install" section has been added with shell command examples and a minimal setup.properties configuration template. This addition aligns with the PR summary mentioning "additions to Casa automated installation instructions."

The example is clear and provides useful automation guidance. However, verify that the flags (-f, -n, -c) and configuration property keys match the actual flex_setup.py script implementation.

To verify the automation flags and properties, please confirm:

  1. Do the flags -f, -n, -c match the current flex_setup.py script options?
  2. Are the properties file keys (e.g., ip, hostname, casa_client_id) valid and complete for Casa automated installation?

You can reference the flex_setup.py script or its documentation to confirm these details.

docs/janssen-server/recipes/apps/teleport.md (1)

18-18: LGTM: Contribution guidance clarified.

Removing the "in the meantime" phrase improves clarity of the contribution prompt. The simplified wording is more direct and timeless, avoiding potential staleness as documentation coverage improves.

docs/janssen-server/recipes/apps/rocket.md (1)

18-18: LGTM: Consistent contribution guidance standardization.

This change mirrors the standardization applied across multiple recipe documentation files, improving consistency and clarity in contribution prompts.

docs/janssen-server/recipes/apps/rancher.md (1)

18-18: LGTM: Consistent contribution guidance standardization.

This change aligns with the standardization of contribution prompts across recipe documentation files.

docs/janssen-server/recipes/api-access-control/access-tokens.md (1)

18-18: LGTM: Consistent contribution guidance standardization.

This change maintains consistency with the standardization of contribution prompts across the recipe documentation suite.

docs/janssen-server/recipes/passportjs.md (1)

161-161: Unable to verify linting fixes without repository access. The verification script cannot be executed against the file to confirm that all trailing spaces and EOF newline corrections have been completed at the flagged lines (161, 165, 180, 206).

docs/janssen-server/planning/benchmarking.md (1)

39-39: All linting fixes are complete.

Verification confirms that both trailing spaces and EOF newline issues have been resolved in docs/janssen-server/planning/benchmarking.md. The file contains no trailing whitespace on any line and properly ends with a newline character.

docs/janssen-server/kubernetes-ops/health-check.md (1)

22-22: LGTM. Formatting-only linting fix; heading semantics unchanged.

docs/janssen-server/kubernetes-ops/README.md (1)

33-33: LGTM. Corrects Memory Dump list entry to standard markdown format, consistent with other entries.

docs/janssen-server/kubernetes-ops/external-secrets-configmaps.md (1)

12-12: LGTM. Formatting-only linting fixes: EOF newlines, spacing standardization, and indentation corrections. No changes to configuration examples or procedural content.

Also applies to: 32-32, 65-65, 72-72, 95-95, 116-116, 119-119, 125-125, 210-210, 226-226

docs/janssen-server/kubernetes-ops/custom-attributes.md (1)

113-113: LGTM. EOF newline added after final code fence; linting-only fix.

docs/janssen-server/kubernetes-ops/upgrade.md (1)

25-25: LGTM. EOF newline added after code fence; linting-only fix.

docs/janssen-server/kubernetes-ops/jans-saml.md (1)

68-68: LGTM. EOF newline added after final code fence; linting-only fix.

docs/janssen-server/kubernetes-ops/scaling.md (1)

34-34: LGTM. Formatting-only linting fixes: spacing standardization and EOF newlines. No changes to scaling procedures or configuration examples.

Also applies to: 52-52, 60-60, 64-64

docs/janssen-server/kubernetes-ops/memory-dump.md (2)

11-11: LGTM. Trailing space removed from table header and EOF newline added; linting fixes approved.

Also applies to: 19-19

19-27: Verification complete: Service entries are accurate but with Helm chart limitation.

The five new service entries in the table all correctly support their respective CN_*_JAVA_OPTIONS environment variables:

  • config-api, fido2, saml, scim: Verified in Helm chart deployment manifests (e.g., ./charts/janssen/charts/config-api/templates/deployment.yaml uses CN_CONFIG_API_JAVA_OPTIONS)
  • link: Verified in Docker deployment (./docker-jans-link/) with CN_LINK_JAVA_OPTIONS defined in README, entrypoint.sh, and Dockerfile

Note: The link service currently has no Helm chart deployment in the janssen chart. If Helm-based deployments are the primary target for this documentation, consider either adding a link Helm chart or documenting that link is only available via Docker deployment.