fix(docs): fix linting issues - trailing spaces and EOF newline #12859
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>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
📝 WalkthroughWalkthroughWidespread documentation edits: primarily whitespace/formatting normalization and standardized contribution wording; targeted documentation updates for SCIM, logs, key rotation, access-evaluation, client-registration, and a new documented scripting method for authorization-challenge. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Areas requiring extra attention:
Possibly related issues
Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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: 14
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/script-catalog/health_check/health-check.md (1)
37-37: Pre-existing typo: "Saample Scrip" should be "Sample Script".While outside the scope of this PR, the section heading contains a typo. Consider fixing this in a follow-up PR focused on content corrections.
docs/script-catalog/authorization_challenge/authorization-challenge.md (1)
47-47: Fix verb tense in method description.Line 47 contains a grammar error. The description should use present tense to match the other method descriptions in the table.
🔎 Proposed fix
-|`def prepareAuthzRequest(self, context)`| Prepared authorization request before `authorize` method. It's good place to restore data from session if needed. | +|`def prepareAuthzRequest(self, context)`| Prepares authorization request before `authorize` method. It's a good place to restore data from session if needed. |
♻️ Duplicate comments (2)
docs/script-catalog/id-token.md (1)
18-18: Content change mirrors scope pattern in other files.Like usermgmt-jans-link.md and README.md in this PR, the "in the meantime" phrase is removed—an editorial change beyond the stated linting scope. See earlier comment on usermgmt-jans-link.md for full scope discussion.
docs/janssen-server/usermgmt/README.md (1)
77-77: Content change mirrors editorial pattern across multiple files.The "in the meantime" phrase removal is consistent with the same change in usermgmt-jans-link.md, id-token.md, and other documentation files. See earlier discussion on scope mismatch between stated linting goals (trailing spaces/EOF newlines) and actual content edits.
📜 Review details
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (50)
docs/janssen-server/usermgmt/README.md(2 hunks)docs/janssen-server/usermgmt/usermgmt-cli-tui.md(1 hunks)docs/janssen-server/usermgmt/usermgmt-jans-link.md(1 hunks)docs/janssen-server/usermgmt/usermgmt-scim.md(4 hunks)docs/janssen-server/vm-ops/backup.md(1 hunks)docs/janssen-server/vm-ops/certificates.md(1 hunks)docs/janssen-server/vm-ops/faq.md(1 hunks)docs/janssen-server/vm-ops/jans-command.md(5 hunks)docs/janssen-server/vm-ops/logs.md(2 hunks)docs/janssen-server/vm-ops/managing-key-rotation.md(4 hunks)docs/janssen-server/vm-ops/restarting-services.md(2 hunks)docs/janssen-server/vm-ops/upgrade.md(2 hunks)docs/janssen-server/vm-ops/web-services.md(1 hunks)docs/script-catalog/access_evaluation/access-evaluation.md(1 hunks)docs/script-catalog/application_session/application-session.md(1 hunks)docs/script-catalog/authorization_challenge/authorization-challenge.md(4 hunks)docs/script-catalog/authz_detail/authz-detail.md(2 hunks)docs/script-catalog/ciba/ciba.md(1 hunks)docs/script-catalog/client_authn/client-authn.md(2 hunks)docs/script-catalog/client_registration/OpenBanking/client-registration.md(3 hunks)docs/script-catalog/client_registration/client-registration.md(1 hunks)docs/script-catalog/client_registration/sample-script/README.md(1 hunks)docs/script-catalog/config_api/config-api.md(1 hunks)docs/script-catalog/cookie/cookie.md(2 hunks)docs/script-catalog/create_user/create-user.md(4 hunks)docs/script-catalog/discovery/discovery.md(2 hunks)docs/script-catalog/discovery/discovery/README.md(2 hunks)docs/script-catalog/dynamic_scope/dynamic-permission/README.md(1 hunks)docs/script-catalog/dynamic_scope/dynamic-scope.md(1 hunks)docs/script-catalog/dynamic_scope/memberof-attribute/README.md(1 hunks)docs/script-catalog/dynamic_scope/org-name/README.md(1 hunks)docs/script-catalog/dynamic_scope/session-parameter/README.md(1 hunks)docs/script-catalog/dynamic_scope/work-phone/README.md(1 hunks)docs/script-catalog/end_session/end-session.md(2 hunks)docs/script-catalog/fido2_extension/fido2-extension.md(1 hunks)docs/script-catalog/health_check/health-check.md(1 hunks)docs/script-catalog/id-token.md(1 hunks)docs/script-catalog/introspection/README.md(3 hunks)docs/script-catalog/introspection/interception-scripts-debug.md(10 hunks)docs/script-catalog/person_authentication/apple-external-authenticator/README.md(1 hunks)docs/script-catalog/person_authentication/basic-external-authenticator/README.md(1 hunks)docs/script-catalog/person_authentication/basic-lock-account-external-authenticator/README.md(1 hunks)docs/script-catalog/person_authentication/duo-external-authenticator/README.md(5 hunks)docs/script-catalog/person_authentication/fido2-external-authenticator/README.md(3 hunks)docs/script-catalog/person_authentication/google-external-authenticator/README.md(1 hunks)docs/script-catalog/person_authentication/other/authz/README.md(1 hunks)docs/script-catalog/person_authentication/other/azuread/README.md(1 hunks)docs/script-catalog/person_authentication/other/basic.change_password/README.md(1 hunks)docs/script-catalog/person_authentication/other/basic.external_logout/README.md(1 hunks)docs/script-catalog/person_authentication/other/basic.lock.account/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
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.
📚 Learning: 2025-12-17T13:07:08.750Z
Learnt from: pujavs
Repo: JanssenProject/jans PR: 12847
File: jans-config-api/docs/jans-config-api-swagger.yaml:15497-15498
Timestamp: 2025-12-17T13:07:08.750Z
Learning: In the JanssenProject/jans repository, Swagger specification files under `jans-config-api/docs/` are auto-generated from underlying API code in source components. Property descriptions must be added in the source components (like `jans-auth`, `jans-fido2`, `jans-lock`) rather than directly in the generated Swagger YAML files.
Applied to files:
docs/janssen-server/usermgmt/README.md
📚 Learning: 2025-11-18T07:43:55.761Z
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:
docs/janssen-server/usermgmt/README.mddocs/janssen-server/vm-ops/logs.md
📚 Learning: 2025-12-17T13:07:08.750Z
Learnt from: pujavs
Repo: JanssenProject/jans PR: 12847
File: jans-config-api/docs/jans-config-api-swagger.yaml:15497-15498
Timestamp: 2025-12-17T13:07:08.750Z
Learning: When reviewing components like `jans-auth`, `jans-fido2`, `jans-lock` in the JanssenProject/jans repository, raise issues about missing property descriptions in API model classes, as these descriptions will be reflected in the auto-generated Swagger specifications.
Applied to files:
docs/janssen-server/usermgmt/README.md
📚 Learning: 2025-11-26T12:38:52.165Z
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:
docs/script-catalog/introspection/interception-scripts-debug.md
📚 Learning: 2025-11-14T12:07:49.986Z
Learnt from: moabu
Repo: JanssenProject/jans PR: 12687
File: terraform-provider-jans/jans/schemas.go:44-61
Timestamp: 2025-11-14T12:07:49.986Z
Learning: In terraform-provider-jans/jans/schemas.go, the SCIM schema endpoints (/jans-scim/restv1/v2/Schemas/) are public discovery endpoints per RFC 7644 and do not require OAuth scopes or authentication tokens. The GetSchemas and GetSchema methods intentionally pass empty strings for token and scope parameters.
Applied to files:
docs/janssen-server/usermgmt/usermgmt-scim.md
🪛 LanguageTool
docs/script-catalog/introspection/interception-scripts-debug.md
[grammar] ~9-~9: Ensure spelling is correct
Context: ...ress. The following steps will walk you trough a setup using Minikube with docker driv...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~419-~419: Use a hyphen to join words.
Context: ...erception-scripts-ksync/basic.py. Right click the upper jansModuleProperty` and...
(QB_NEW_EN_HYPHEN)
docs/script-catalog/introspection/README.md
[style] ~10-~10: ‘whether or not’ might be wordy. Consider a shorter alternative.
Context: ...ver to evaluate policies that determine whether or not to allow the request. Token introspecti...
(EN_WORDINESS_PREMIUM_WHETHER_OR_NOT)
docs/script-catalog/person_authentication/basic-lock-account-external-authenticator/README.md
[style] ~11-~11: ‘in the meantime’ might be wordy. Consider a shorter alternative.
Context: ...t you'd like to contribute to this page in the meantime, you can get started with our [Contribu...
(EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)
docs/janssen-server/usermgmt/usermgmt-scim.md
[style] ~48-~48: Consider a more concise word here.
Context: ...k`|Send requests to the bulk endpoint| In order to facilitate the process of getting an ac...
(IN_ORDER_TO_PREMIUM)
docs/script-catalog/person_authentication/other/authz/README.md
[style] ~11-~11: ‘in the meantime’ might be wordy. Consider a shorter alternative.
Context: ...t you'd like to contribute to this page in the meantime, you can get started with our [Contribu...
(EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)
docs/script-catalog/person_authentication/fido2-external-authenticator/README.md
[grammar] ~17-~17: Use a hyphen to join words.
Context: ...2-devices). ### FIDO2 devices Some well known FIDO2 devices and manufacturers in...
(QB_NEW_EN_HYPHEN)
docs/script-catalog/client_registration/OpenBanking/client-registration.md
[grammar] ~15-~15: Use a hyphen to join words.
Context: ...-using-jans-cli). 1. jans-cli in command line argument mode is more conducive to ...
(QB_NEW_EN_HYPHEN)
docs/script-catalog/authorization_challenge/authorization-challenge.md
[style] ~54-~54: To form a complete sentence, be sure to include a subject.
Context: ...s authenticated. prepareAuthzRequest should typically be used for authorization req...
(MISSING_IT_THERE)
🪛 markdownlint-cli2 (0.18.1)
docs/script-catalog/person_authentication/other/azuread/README.md
2-2: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
docs/janssen-server/vm-ops/web-services.md
18-18: Table column count
Expected: 2; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
docs/script-catalog/person_authentication/other/basic.lock.account/README.md
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
1-1: Link text should be descriptive
(MD059, descriptive-link-text)
docs/janssen-server/usermgmt/usermgmt-scim.md
53-53: Link text should be descriptive
(MD059, descriptive-link-text)
80-80: Link text should be descriptive
(MD059, descriptive-link-text)
82-82: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
docs/janssen-server/vm-ops/restarting-services.md
18-18: Table column count
Expected: 2; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
46-46: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
docs/janssen-server/vm-ops/backup.md
19-19: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
21-21: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
22-22: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
⏰ 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)
- GitHub Check: Deploy docs
- GitHub Check: lint_docs
🔇 Additional comments (56)
docs/script-catalog/cookie/cookie.md (1)
8-8: ✓ Linting fixes applied correctly.Trailing whitespace has been removed from the markdown headings at lines 8 and 35, aligning with the PR objectives. No content changes, only cosmetic formatting normalization.
Also applies to: 35-35
docs/script-catalog/client_authn/client-authn.md (1)
1-147: Whitespace-only formatting fixes look appropriate.The changes on lines 19, 21, and 49 appear to be trailing space removals, which aligns with the PR objective of fixing linting issues. The AI summary confirms no semantic content changes. The markdown structure, links, code examples, and YAML frontmatter all remain intact.
Please verify that:
- The marked changes (lines 19, 21, 49) were only trailing space removals and not substantive edits
- An EOF newline was properly added to the file end (this may not be visible in the diff view)
docs/script-catalog/health_check/health-check.md (2)
95-95: Trailing space removal is correct.The removal of the trailing space after the closing code fence aligns with the PR's linting objectives.
94-97: Verify EOF newline was added.The PR objectives specify adding EOF newlines, but the provided diff does not explicitly show whether a newline was added after line 97. Please confirm that the file now ends with a proper newline character after the "## Sample Scripts" section.
docs/script-catalog/config_api/config-api.md (2)
25-25: ✓ Whitespace normalization aligns with PR objectives.The removal of trailing whitespace from the heading is appropriate and follows the stated PR goal of resolving documentation linting issues.
1-109: Verify EOF newline was added as stated in PR objectives.The PR objectives indicate both trailing spaces should be removed and EOF newlines should be added. The provided code annotation confirms the trailing space removal on line 25, but the presence of a trailing newline at EOF is not visible in the provided context. Please confirm the EOF newline has been added to this file as part of the linting fix.
docs/script-catalog/person_authentication/basic-lock-account-external-authenticator/README.md (1)
9-11: Inconsistency: "in the meantime" not removed despite PR objective.The high-level PR summary states the changes include "standardizing contribution notice wording by removing 'in the meantime' from contributor guidelines," yet this file still contains "in the meantime" on line 11. The file-specific summary claims only formatting changed (bullet point removal), with no content changes—but this appears inconsistent with the stated PR objective.
Additionally, LanguageTool flags "in the meantime" as a potentially wordy phrase, reinforcing that removing it aligns with the documentation improvements mentioned in the PR.
Verify whether this file should have "in the meantime" removed to match other files in this PR, or clarify the scope of the PR objectives.
docs/script-catalog/discovery/discovery.md (1)
8-8: Whitespace-only linting fixes align with PR objective.Both header lines have trailing spaces removed as intended. The documentation content, code examples, and cross-references remain intact. No functional or content changes.
Also applies to: 137-137
docs/script-catalog/discovery/discovery/README.md (1)
8-8: Whitespace normalization is consistent with PR objective.Line 8 trailing space removed, line 50 blank line cleaned up. Documentation content, links to script examples, and method descriptions remain functionally unchanged.
Also applies to: 50-50
docs/script-catalog/access_evaluation/access-evaluation.md (5)
12-17: Mismatch between PR title and actual changes—update description to reflect scope.The PR title states "fix(docs): fix linting issues - trailing spaces and EOF newline," but the actual changes include substantive documentation improvements: enhanced AuthZEN API descriptions (lines 12–17), a new behavior section (lines 23–28), and new fallback behavior documentation (lines 30–33). These are beyond whitespace normalization.
Update the PR description to accurately reflect the scope of changes and ensure the checklist items (guidelines, license review, static analysis, tests, documentation) are reviewed and marked appropriately.
Also applies to: 23-28, 30-33
12-17: Content quality: AuthZEN API description enhancement is clear and accurate.The reflow of the OpenID AuthZEN API description (lines 12–17) better emphasizes the standardized interface for authorization and explicitly reinforces the "dynamic authorization" and "transport-agnostic" nature. The restructured sentences improve readability and technical clarity.
23-28: Content quality: Behavior section provides needed clarity on Access Evaluation Endpoint mechanism.The new behavior section (lines 23–28) offers concrete detail on how the endpoint evaluates subject, resource, and action against policies, and emphasizes real-time decision provision and scalability. This improves understanding of the endpoint's role within the AuthZEN specification.
30-33: Content quality: Fallback behavior documentation is a valuable addition.The new fallback behavior explanation (lines 30–33)—that the server executes the first script found in the database if the named script is not found or the property is not specified—is a critical operational detail that was previously undocumented. This clarification helps users understand script resolution behavior.
12-17: Whitespace fixes verified.Trailing spaces have been successfully removed throughout the file and the file correctly ends with a newline. The stated primary goals of the PR have been completed.
docs/script-catalog/person_authentication/other/basic.change_password/README.md (1)
11-11: Minor scope expansion: Wording improvement outside stated linting fixes.This change removes "in the meantime" for clarity, which improves readability but is a substantive content edit rather than a linting/whitespace fix as described in the PR objective.
docs/script-catalog/person_authentication/other/authz/README.md (1)
11-11: Aligns with static analysis feedback: Removes redundant phrase.This change directly addresses the LanguageTool style hint flagging "in the meantime" as wordy.
docs/script-catalog/person_authentication/other/basic.external_logout/README.md (1)
3-3: Grammar improvement: Clearer phrasing.Corrects awkward construction ("hasn't properties") to standard English ("has no properties"). Good clarity improvement, though outside the stated scope of whitespace/linting fixes.
docs/script-catalog/person_authentication/fido2-external-authenticator/README.md (1)
7-9: Approve formatting and line-break adjustments.The rewordings on lines 7–9 and blank-line adjustments on lines 67–71 improve readability and document flow.
Also applies to: 67-71
docs/script-catalog/person_authentication/google-external-authenticator/README.md (1)
57-57: Approve formatting cleanup: Remove spurious bullet marker.Removes leading dash that was not part of a list structure, improving markdown formatting for the Properties section heading.
docs/script-catalog/person_authentication/apple-external-authenticator/README.md (1)
30-30: LGTM: Trailing whitespace removal.Legitimate linting fix aligned with the PR objective.
docs/script-catalog/person_authentication/basic-external-authenticator/README.md (1)
11-11: Contribution guide text is appropriately refined.The updated wording for the contribution section aligns with best practices for documentation contributor guidance.
docs/script-catalog/person_authentication/duo-external-authenticator/README.md (2)
5-5: Grammar and clarity improvements are welcome.Minor improvements to wording and punctuation enhance readability:
- Line 5: Opening description is more concise
- Line 46: Clearer reference to Duo's Web SDK documentation
- Line 163-164: Grammar correction improves flow
Also applies to: 46-46, 163-164
142-143: Note block formatting uses standard Markdown syntax.The
!!! Noteblock is correctly formatted per Markdown conventions for admonitions.docs/script-catalog/authz_detail/authz-detail.md (2)
104-104: Heading grammar correction is accurate.The change from "details is present" to "details are present" correctly applies plural subject-verb agreement, improving the heading clarity.
45-45: Content clarifications improve readability.Minor grammatical refinements enhance sentence flow and comprehension:
- Line 45: Improves clarity of administrative requirement
- Line 47: Clarifies behavior when parameter is absent
Also applies to: 47-47
docs/script-catalog/authorization_challenge/authorization-challenge.md (2)
64-64: New use case sections and implementation examples are well-documented.The addition of a "Common Use Case" heading and the multi-step authorization example with full implementation of the new
prepareAuthzRequestmethod appropriately document the intended usage patterns.Also applies to: 262-262
467-477: prepareAuthzRequest implementation correctly demonstrates scope restoration from session.The code example properly implements the described behavior: retrieving scope from device session and applying it when the request scope is empty. This aligns with the documented method purpose.
docs/script-catalog/introspection/interception-scripts-debug.md (1)
28-28: Approve whitespace normalization and EOF newline additions.The trailing-space removals and blank-line normalizations across these lines align with the stated PR objective of fixing linting issues. These changes improve documentation hygiene without altering content semantics.
Also applies to: 34-34, 40-40, 65-65, 71-71, 77-77, 197-197, 211-211, 400-400, 416-416, 447-447, 449-449, 487-487, 489-489, 491-491
docs/script-catalog/introspection/README.md (1)
29-29: Approve whitespace normalization and EOF newline additions.The blank-line adjustments and EOF newline additions conform to the PR objective of fixing linting issues. These changes improve documentation structure without altering semantic content.
Also applies to: 44-44, 47-47, 50-50
docs/script-catalog/ciba/ciba.md (1)
104-106: Documentation wording refinement is appropriate.The removal of "in the meantime" from the contribution guidance aligns with similar updates across the repository for consistency and clarity.
docs/janssen-server/vm-ops/certificates.md (1)
9-9: Trailing space removal looks good.The header formatting cleanup is consistent with the PR objective to normalize whitespace.
docs/janssen-server/vm-ops/upgrade.md (1)
12-15: Whitespace normalization and formatting improvements are appropriate.The text reflow and added blank lines improve markdown consistency and readability without affecting the instructional content.
Also applies to: 36-36, 40-40
docs/janssen-server/vm-ops/web-services.md (1)
16-18: Documentation wording refinement approved, but pre-existing linting issue remains unresolved.The "in the meantime" removal is consistent with other files. However, the markdownlint static analysis tool reports an MD056 error (table column count mismatch) at line 18 that conflicts with the PR objective to "fix linting issues." Please verify whether this pre-existing issue should be resolved in this PR.
docs/janssen-server/vm-ops/restarting-services.md (1)
18-18: Trailing space removal approved, but linting issues remain unresolved.Line 18: The trailing space removal is appropriate. However, the MD056 error (table column count mismatch) persists.
Line 46: The code fence adjustment appears to address the MD031 rule (blank lines around fences), but per static analysis, this linting error is still flagged. Please verify the formatting is correct and the linting issues are fully resolved.
Also applies to: 46-48
docs/script-catalog/dynamic_scope/dynamic-permission/README.md (1)
9-11: Documentation wording refinement is appropriate.The "in the meantime" removal maintains clarity and is consistent with similar updates across the repository.
docs/script-catalog/client_registration/sample-script/README.md (1)
9-11: Documentation wording refinement is appropriate.The "in the meantime" removal aligns with similar updates across the repository for consistency and clarity.
docs/janssen-server/vm-ops/jans-command.md (1)
12-16: Text reflow changes are cosmetic and maintain semantic accuracy.The documentation text is rewrapped but the meaning and instructions remain unchanged. Assuming trailing spaces and EOF newlines are properly fixed (as claimed in the PR title), these changes appear safe.
Please confirm that the linter validation passes on this file (trailing spaces removed, EOF newline added) before merge, as these fixes are not visible in the diff.
Also applies to: 26-27, 50-50, 53-53, 71-71, 112-112
docs/janssen-server/usermgmt/usermgmt-cli-tui.md (1)
52-52: LGTM—table formatting normalized.Trailing whitespace removed from the Country row without affecting table rendering or content.
docs/script-catalog/application_session/application-session.md (1)
145-145: LGTM—header formatting normalized.Section header spacing adjusted for markdown linting compliance.
docs/script-catalog/client_registration/client-registration.md (1)
268-268: LGTM—markdown list formatting corrected.Single-dash list syntax is standard markdown; double-dash formatting is normalized.
docs/janssen-server/usermgmt/README.md (1)
18-18: LGTM—section spacing normalized.Blank line adjustments around SCIM and Link sections align with markdown heading spacing rules (MD022).
Also applies to: 22-22
docs/janssen-server/usermgmt/usermgmt-scim.md (1)
46-46: Replace generic link text with descriptive alternatives throughout the document.The review identifies some valid issues but contains inaccuracies:
MD059 (Link text descriptiveness): Multiple
[here]links need replacement with descriptive text. Lines 53, 60, 65, 70, 76, 80, 85, 89, 94, 99, 103, 107, and 111 all contain non-descriptive link text. Examples: "SCIM logs guide" for line 53, "SCIM configuration details" for line 60.MD022 (Heading spacing): Line 82 (
## Creating Resource) already has a proper blank line before it—no fix needed.Line 56 typo: Confirmed—"aslo" should be "also".
Likely an incorrect or invalid review comment.
docs/janssen-server/vm-ops/faq.md (1)
18-18: LGTM!The removal of "in the meantime" improves sentence flow and clarity in the contribution guidance.
docs/script-catalog/client_registration/OpenBanking/client-registration.md (1)
103-160: Verify accuracy of new Python script documentation.The expanded "Understanding the Script" section adds substantive code examples and mandatory function signatures (init, createClient, getSoftwareStatementJwks, getDcrHmacSecret, getDcrJwks, updateClient). Before merge, confirm:
- The documented function signatures and return types match the actual
ClientRegistrationTypeinterface- The init method signature matches what the framework expects
- The example business logic in
createClient(lines 131–160) reflects current best practices for this script type- Print statements in Python code examples are appropriate (consider if they should use logging instead)
docs/janssen-server/vm-ops/logs.md (3)
16-24: LGTM!The table reformatting improves clarity and consistency for the Log Levels section.
29-87: LGTM!The expanded configuration instructions with command examples and output samples significantly improve usability for users managing log levels via jans-cli.
104-110: LGTM!The addition of new Config API log files (
configapi_persistence_duration.logand[date].jetty.log) provides more comprehensive coverage of available logs.docs/janssen-server/vm-ops/managing-key-rotation.md (3)
33-33: LGTM!The fix for the duplicate "case" word improves clarity and correctness.
35-35: LGTM!The grammar correction from "old one are" to "old ones are" improves sentence correctness.
41-41: Improve grammar and clarity in the key sync documentation.The newly added line about key store and JWKS synchronization is important, but the phrasing has minor grammatical issues:
- "key inside key store file must have representation in jwks" → consider "each key in the key store file must be represented in the JWKS and vice versa"
- "It must be always in sync" → "They must always be kept in sync"
Verify that this synchronization requirement is accurate, then refine the wording for clarity.
-It's important to note that key inside key store file must have representation in jwks and vice versa. It must be always in sync otherwise AS will throw error. +It's important to note that keys in the key store file must have a corresponding representation in the JWKS, and vice versa. They must always be kept in sync; otherwise, the Authorization Server will throw an error.docs/script-catalog/dynamic_scope/dynamic-scope.md (1)
10-10: LGTM!The textual refinement in the opening paragraph improves readability and clarity.
docs/script-catalog/dynamic_scope/org-name/README.md (1)
11-11: LGTM!The removal of "in the meantime" improves sentence clarity and directness in the contribution guidance.
docs/script-catalog/dynamic_scope/session-parameter/README.md (1)
11-11: LGTM!The removal of "in the meantime" improves sentence flow and clarity in the contribution guidance.
docs/script-catalog/dynamic_scope/work-phone/README.md (1)
11-11: LGTM!The removal of "in the meantime" improves sentence clarity in the contribution guidance.
docs/script-catalog/dynamic_scope/memberof-attribute/README.md (1)
5-11: Inconsistency between PR objective and marked changes.The PR description emphasizes removing trailing spaces and adding EOF newlines (linting fixes), but the summary describes removing the phrase "in the meantime" and simplifying contribution guide wording (editorial changes). Line 5 contains "in the meantime" but is unmarked; only line 11 (the contribution guide text) is marked as changed.
Clarify whether this file's changes are linting-focused (as per PR objective) or include editorial updates. If editorial changes are intentional, ensure they align with PR scope.
docs/script-catalog/end_session/end-session.md (1)
36-36: Linting fixes align with PR objectives.Line 36: Removing trailing whitespace after the period is a correct formatting fix.
Line 123: Adding the trailing newline at EOF ensures proper file termination per linting standards.
Both changes are purely formatting-focused and align with the stated PR objective of resolving documentation linting issues.
Also applies to: 123-123
docs/script-catalog/authorization_challenge/authorization-challenge.md
Outdated
Show resolved
Hide resolved
docs/script-catalog/client_registration/OpenBanking/client-registration.md
Outdated
Show resolved
Hide resolved
docs/script-catalog/person_authentication/fido2-external-authenticator/README.md
Outdated
Show resolved
Hide resolved
docs/script-catalog/person_authentication/other/basic.lock.account/README.md
Show resolved
Hide resolved
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
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/janssen-server/usermgmt/usermgmt-scim.md (1)
82-94: Add blank line above section heading to comply with MD022.The section heading
## Creating Resource(line 82) violates markdownlint MD022: headings must be surrounded by blank lines. Add a blank line above the heading.🔎 Proposed fix
You can refer to [here](../../janssen-server/config-guide/scim-config/user-config.md#updating-a-user-patch) for this topic + ## Creating Resource ### Create an Userdocs/script-catalog/person_authentication/fido2-external-authenticator/README.md (1)
1-140: Remove trailing whitespace on multiple lines.The file still contains trailing spaces on lines 12, 13, 19, 20, 21, 22, and 43. These need to be removed to complete the whitespace cleanup objective.
♻️ Duplicate comments (1)
docs/script-catalog/person_authentication/other/basic.lock.account/README.md (1)
1-3: Partial fix: MD041 resolved, but MD059 (descriptive link text) remains unresolved.The PR successfully addresses the MD041 violation by adding the heading
## Basic Lock Accounton line 1. However, the MD059 violation on line 3 persists—the link text[here]is not descriptive and should clearly indicate the target resource (e.g., "Jython script" or "View the script").This was flagged in the previous review; please complete the fix to fully resolve all linting violations.
🔎 Proposed fix for descriptive link text
-Script contents [here](https://github.com/JanssenProject/jans/jans-linux-setup/static/extension/person_authentication/BasicLockAccountExternalAuthenticator.py) +Script contents: [Jython implementation](https://github.com/JanssenProject/jans/jans-linux-setup/static/extension/person_authentication/BasicLockAccountExternalAuthenticator.py)
📜 Review details
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (10)
docs/janssen-server/usermgmt/usermgmt-scim.md(4 hunks)docs/script-catalog/authorization_challenge/authorization-challenge.md(4 hunks)docs/script-catalog/client_registration/OpenBanking/client-registration.md(6 hunks)docs/script-catalog/create_user/create-user.md(5 hunks)docs/script-catalog/fido2_extension/fido2-extension.md(4 hunks)docs/script-catalog/introspection/README.md(3 hunks)docs/script-catalog/introspection/interception-scripts-debug.md(15 hunks)docs/script-catalog/person_authentication/fido2-external-authenticator/README.md(3 hunks)docs/script-catalog/person_authentication/other/azuread/README.md(1 hunks)docs/script-catalog/person_authentication/other/basic.lock.account/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📚 Learning: 2025-11-26T12:38:52.165Z
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:
docs/script-catalog/introspection/interception-scripts-debug.md
📚 Learning: 2025-12-04T12:17:12.662Z
Learnt from: olehbozhok
Repo: JanssenProject/jans PR: 12797
File: jans-cedarling/AGENTS.md:82-88
Timestamp: 2025-12-04T12:17:12.662Z
Learning: In the jans-cedarling project, the AGENTS.md file is AI-generated and used only by AI agents, so markdown linting issues (such as MD031, MD040) for this file can be ignored during code reviews.
Applied to files:
docs/script-catalog/fido2_extension/fido2-extension.mddocs/script-catalog/person_authentication/other/basic.lock.account/README.mddocs/script-catalog/person_authentication/other/azuread/README.mddocs/script-catalog/create_user/create-user.md
📚 Learning: 2025-12-17T13:07:08.750Z
Learnt from: pujavs
Repo: JanssenProject/jans PR: 12847
File: jans-config-api/docs/jans-config-api-swagger.yaml:15497-15498
Timestamp: 2025-12-17T13:07:08.750Z
Learning: When reviewing components like `jans-auth`, `jans-fido2`, `jans-lock` in the JanssenProject/jans repository, raise issues about missing property descriptions in API model classes, as these descriptions will be reflected in the auto-generated Swagger specifications.
Applied to files:
docs/script-catalog/person_authentication/other/basic.lock.account/README.md
📚 Learning: 2025-11-14T12:07:49.986Z
Learnt from: moabu
Repo: JanssenProject/jans PR: 12687
File: terraform-provider-jans/jans/schemas.go:44-61
Timestamp: 2025-11-14T12:07:49.986Z
Learning: In terraform-provider-jans/jans/schemas.go, the SCIM schema endpoints (/jans-scim/restv1/v2/Schemas/) are public discovery endpoints per RFC 7644 and do not require OAuth scopes or authentication tokens. The GetSchemas and GetSchema methods intentionally pass empty strings for token and scope parameters.
Applied to files:
docs/janssen-server/usermgmt/usermgmt-scim.md
🪛 LanguageTool
docs/janssen-server/usermgmt/usermgmt-scim.md
[style] ~48-~48: Consider a more concise word here.
Context: ...k`|Send requests to the bulk endpoint| In order to facilitate the process of getting an ac...
(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.18.1)
docs/script-catalog/fido2_extension/fido2-extension.md
16-16: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/script-catalog/person_authentication/other/basic.lock.account/README.md
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
3-3: Link text should be descriptive
(MD059, descriptive-link-text)
docs/janssen-server/usermgmt/usermgmt-scim.md
53-53: Link text should be descriptive
(MD059, descriptive-link-text)
80-80: Link text should be descriptive
(MD059, descriptive-link-text)
82-82: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
docs/script-catalog/person_authentication/fido2-external-authenticator/README.md
7-7: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
🔇 Additional comments (19)
docs/script-catalog/person_authentication/other/azuread/README.md (1)
2-4: ✅ MD041 violation resolved.The addition of the top-level heading "## Azure AD Authentication" correctly addresses the markdownlint MD041 violation flagged in the previous review. The heading is properly formatted with appropriate blank-line spacing, and the descriptive content remains intact.
docs/script-catalog/client_registration/OpenBanking/client-registration.md (3)
15-15: ✅ Hyphenation fix applied correctly.The phrase "command-line argument mode" is now properly hyphenated when used as a compound adjective. This addresses the previous grammar feedback.
97-97: ✅ Sentence clarification completed.The sentence now reads "The Client Registration script is available at the link above." This completes the thought and provides clear direction to the reader, addressing the previous feedback about the incomplete statement.
1-196: Documentation linting fixes properly applied.The changes consistently address the stated PR objective of removing trailing whitespace and normalizing line endings. No content issues detected; the document retains its clarity and technical accuracy while improving formatting standards.
docs/script-catalog/introspection/interception-scripts-debug.md (3)
9-9: Previous feedback successfully incorporated: spelling fix "trough" → "through".The spelling correction from the prior review has been applied. The sentence now correctly reads "The following steps will walk you through a setup..."
Also applies to: 9-9
419-419: Previous feedback successfully incorporated: hyphenation "Right click" → "Right-click".The compound modifier has been properly hyphenated per style guidelines. The instruction now correctly reads "Right-click the upper
jansModuleProperty..."Also applies to: 419-419
28-28: Whitespace normalization and EOF newline additions applied throughout.The file has been normalized to remove trailing spaces and ensure proper line endings in code blocks and instruction lists, consistent with the PR's stated objective. The changes maintain content fidelity while improving linting compliance.
Also applies to: 34-34, 40-40, 63-63, 65-65, 71-71, 77-77, 96-96, 109-109, 115-115, 117-117, 125-125, 126-126, 159-159, 162-162, 166-166, 197-197, 211-211, 213-213, 215-215, 217-217, 219-219, 221-221, 222-222, 283-283, 295-295, 297-297, 305-305, 400-400, 416-416, 433-433, 447-447, 449-449, 451-451, 453-453, 455-455, 457-457, 460-460, 487-487, 489-489, 491-491
docs/script-catalog/create_user/create-user.md (1)
1-242: No issues found. The file has no trailing spaces and properly ends with a newline character.docs/script-catalog/introspection/README.md (2)
10-10: Excellent: resolves prior linting feedback on wordiness.Line 10 now uses "whether to allow the request" instead of "whether or not to allow the request," addressing the LanguageTool linting flag from the prior review and improving readability without loss of meaning.
29-29: Whitespace normalization verified as intended.The commit "fix(docs): fix linting issues - trailing spaces and EOF newline" (3dd372c) confirms the changes are limited to whitespace cleanup. Lines 29 and 47 contain legitimate markdown documentation content, while lines 44 and 50 are blank lines where trailing spaces were removed. The file ends with a proper newline (line 63), and no unintended content edits were made.
docs/janssen-server/usermgmt/usermgmt-scim.md (1)
56-56: Verify typo fix status for "aslo" → "also".Line 56 contains the typo "aslo" (in "If you use SCIM custom script aslo see..."), but this line is marked as unchanged (~). The AI summary indicates "aslo → also" should be corrected. Clarify whether this typo has already been fixed in a prior commit, or if it remains unaddressed.
docs/script-catalog/authorization_challenge/authorization-challenge.md (3)
54-56: ✓ Sentence structure improvements applied.The reformatted text at lines 54–56 successfully addresses the previous concern about missing subject and clarity. The sentences now form complete, grammatically correct statements with proper formatting of method names.
267-267: Clarify code block language specification.Line 267 changes the code fence from
javatotext. Please confirm this is intentional—if this is meant to be valid Java code, it should remain labeled asjava. If it's pseudocode or a template, thetextlabel is appropriate, but a comment in the code or in the documentation should explain why the syntax differs from the first example.
468-479: ✓ NewprepareAuthzRequestmethod properly documented.The new method implementation correctly demonstrates reading scope from the device session and applying it to the request for multi-step flows. The implementation is clear and well-integrated into the documentation.
docs/script-catalog/fido2_extension/fido2-extension.md (2)
16-21: Add language specification to fenced code block.The code block starting at line 16 is missing a language identifier, violating markdown linting rule MD040.
-``` +```text https://<myjans-server>/jans-fido2/restv1/attestation/options (register)
54-277: All markdown linting issues have been resolved.Verification confirms that trailing spaces have been completely removed from all flagged lines (14, 17, 86, 157, 164, 217, 224, 231, 238, 245, 253, 260, 267, 274, 277), the EOF newline is properly present, and code fence language specifications are correctly in place (
python andjava). No further action needed.docs/script-catalog/person_authentication/fido2-external-authenticator/README.md (3)
17-17: Grammar fix applied: "well-known" hyphenation. ✓The hyphenation issue flagged in the previous review has been correctly addressed on line 17.
71-78: File already ends with a proper newline. The verification confirms the filedocs/script-catalog/person_authentication/fido2-external-authenticator/README.mdproperly terminates with a newline character and requires no changes.
7-7: Static analysis false positive: Line 7 is not a heading and requires no fix.Line 7 is the start of a multi-line paragraph (lines 7–9), not a markdown heading. The document structure is correct: blank lines properly separate paragraphs and headings. No changes needed.
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/janssen-server/usermgmt/usermgmt-scim.md(4 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-11-14T12:07:49.986Z
Learnt from: moabu
Repo: JanssenProject/jans PR: 12687
File: terraform-provider-jans/jans/schemas.go:44-61
Timestamp: 2025-11-14T12:07:49.986Z
Learning: In terraform-provider-jans/jans/schemas.go, the SCIM schema endpoints (/jans-scim/restv1/v2/Schemas/) are public discovery endpoints per RFC 7644 and do not require OAuth scopes or authentication tokens. The GetSchemas and GetSchema methods intentionally pass empty strings for token and scope parameters.
Applied to files:
docs/janssen-server/usermgmt/usermgmt-scim.md
🪛 LanguageTool
docs/janssen-server/usermgmt/usermgmt-scim.md
[style] ~48-~48: Consider a more concise word here.
Context: ...k`|Send requests to the bulk endpoint| In order to facilitate the process of getting an ac...
(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.18.1)
docs/janssen-server/usermgmt/usermgmt-scim.md
80-80: Link text should be descriptive
(MD059, descriptive-link-text)
82-82: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/janssen-server/usermgmt/usermgmt-scim.md (1)
49-49: Fix grammatically awkward phrasing in line 49.The phrase "In order to facilitate the process of getting," appears incomplete or awkwardly constructed. The LanguageTool style checker flags this as overly verbose.
🔎 Proposed fix
-In order to facilitate the process of getting, your Janssen installation already bundles an OAuth client named "SCIM client" with support for all the scopes above. +To facilitate getting an access token, your Janssen installation already bundles an OAuth client named "SCIM client" with support for all the scopes above.
📜 Review details
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/janssen-server/usermgmt/usermgmt-scim.md(5 hunks)
🧰 Additional context used
🧠 Learnings (4)
📚 Learning: 2025-12-04T12:17:12.662Z
Learnt from: olehbozhok
Repo: JanssenProject/jans PR: 12797
File: jans-cedarling/AGENTS.md:82-88
Timestamp: 2025-12-04T12:17:12.662Z
Learning: In the jans-cedarling project, the AGENTS.md file is AI-generated and used only by AI agents, so markdown linting issues (such as MD031, MD040) for this file can be ignored during code reviews.
Applied to files:
docs/janssen-server/usermgmt/usermgmt-scim.md
📚 Learning: 2025-12-17T13:07:08.750Z
Learnt from: pujavs
Repo: JanssenProject/jans PR: 12847
File: jans-config-api/docs/jans-config-api-swagger.yaml:15497-15498
Timestamp: 2025-12-17T13:07:08.750Z
Learning: When reviewing components like `jans-auth`, `jans-fido2`, `jans-lock` in the JanssenProject/jans repository, raise issues about missing property descriptions in API model classes, as these descriptions will be reflected in the auto-generated Swagger specifications.
Applied to files:
docs/janssen-server/usermgmt/usermgmt-scim.md
📚 Learning: 2025-10-30T15:21:12.720Z
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:
docs/janssen-server/usermgmt/usermgmt-scim.md
📚 Learning: 2025-11-14T12:07:49.986Z
Learnt from: moabu
Repo: JanssenProject/jans PR: 12687
File: terraform-provider-jans/jans/schemas.go:44-61
Timestamp: 2025-11-14T12:07:49.986Z
Learning: In terraform-provider-jans/jans/schemas.go, the SCIM schema endpoints (/jans-scim/restv1/v2/Schemas/) are public discovery endpoints per RFC 7644 and do not require OAuth scopes or authentication tokens. The GetSchemas and GetSchema methods intentionally pass empty strings for token and scope parameters.
Applied to files:
docs/janssen-server/usermgmt/usermgmt-scim.md
🪛 LanguageTool
docs/janssen-server/usermgmt/usermgmt-scim.md
[style] ~48-~48: Consider a more concise word here.
Context: ...k`|Send requests to the bulk endpoint| In order to facilitate the process of getting, your...
(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.18.1)
docs/janssen-server/usermgmt/usermgmt-scim.md
80-80: Link text should be descriptive
(MD059, descriptive-link-text)
🔇 Additional comments (1)
docs/janssen-server/usermgmt/usermgmt-scim.md (1)
82-84: Add blank line after heading to resolve MD022 violation.The heading "## Creating Resource" at line 82 is immediately followed by "### Create an User" at line 84 without a blank line between them. Markdown rule MD022 requires headings to be surrounded by blank lines on both sides.
🔎 Proposed fix
## Creating Resource + ### Create an UserLikely an incorrect or invalid review comment.
Prepare
Description
Target issue
closes #issue-number-here
Implementation Details
Test and Document the changes
Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with
docs:to indicate documentation changes or if the below checklist is not selected.Summary by CodeRabbit
New Features
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.