Added docs fo User & Organization Settings#877
Conversation
Added docs for User & Organization Settings.
WalkthroughUpdated left-nav metadata and documentation under configuration/security and configuration: renamed one Security label, added four navigation entries, created four new docs (org-settings, password-policy, setup-two-factor-authentication, user-settings), and adjusted front matter (page_id/order) for SSO provider pages and the security overview. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20–30 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
src/pages/docs/configuration/security/setup-two-factor-authentication.md (1)
35-35: Use heading syntax instead of emphasis for section title.Line 35 should use Markdown heading syntax (
##) rather than bold emphasis to maintain consistent documentation structure and pass linting checks.Apply this diff to fix the heading formatting:
-**Enable Two-Factor Authentication** +## **Enable Two-Factor Authentication**src/pages/docs/configuration/security/overview.md (2)
48-48: Fix URL protocol inconsistency.Line 48 uses
http://while other documentation links usehttps://. Update to match the HTTPS standard used throughout the documentation.Apply this diff to fix the URL:
-For details, see [Configure Organization Settings](http://testsigma.com/docs/configuration/security/org-settings/). +For details, see [Configure Organization Settings](https://testsigma.com/docs/configuration/security/org-settings/).
52-56: Simplify redundant phrase on line 54.The phrase "adds an additional layer" is slightly verbose. Consider "provides an extra layer" or simply "adds a layer" for more concise writing.
Apply this diff to simplify:
-Two-Factor Authentication adds an additional layer of security by requiring users to verify their identity using a second factor during sign-in. +Two-Factor Authentication provides an extra layer of security by requiring users to verify their identity using a second factor during sign-in.src/pages/docs/configuration/user-settings.md (1)
29-31: Remove duplicate text on line 31.The opening paragraph contains redundant information: "This article explains how to manage your User Settings in Testsigma. This article discusses configuring User Settings in Testsigma." Consolidate into a single, clear sentence.
Apply this diff to remove redundancy:
-You can configure user-level settings such as updating your profile information, changing your password, and enabling Two-Factor Authentication (2FA) to add an extra layer of security to your account. This article explains how to manage your User Settings in Testsigma. This article discusses configuring User Settings in Testsigma. +You can configure user-level settings such as updating your profile information, changing your password, and enabling Two-Factor Authentication (2FA) to add an extra layer of security to your account.src/pages/docs/configuration/security/password-policy.md (1)
40-40: Fix grammar error on line 40.Line 40 contains a grammar error: "select the each setting" should be "select each setting".
Apply this diff to fix the grammar:
-3. In the **Configure Password Policy** dialog, select the each setting you want to enable. +3. In the **Configure Password Policy** dialog, select each setting you want to enable.src/pages/docs/configuration/security/org-settings.md (1)
45-45: Add missing link to Password Policy documentation.Line 45 references "Password Policy" but doesn't include a link to the dedicated Password Policy page. This should match the pattern used in the overview.md and user-settings.md files.
Apply this diff to add the missing link:
-To learn how to configure password-related security controls, see Password Policy. +To learn how to configure password-related security controls, see [Configure Password Policy](https://testsigma.com/docs/configuration/security/password-policy/).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
src/left-nav-title.json(2 hunks)src/pages/docs/configuration/security/azure-sso.md(1 hunks)src/pages/docs/configuration/security/google-sso.md(1 hunks)src/pages/docs/configuration/security/okta-sso.md(1 hunks)src/pages/docs/configuration/security/org-settings.md(1 hunks)src/pages/docs/configuration/security/overview.md(2 hunks)src/pages/docs/configuration/security/password-policy.md(1 hunks)src/pages/docs/configuration/security/setup-two-factor-authentication.md(1 hunks)src/pages/docs/configuration/user-settings.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/docs/configuration/security/overview.md
[style] ~54-~54: This phrase might be redundant. Consider either removing or replacing the adjective ‘additional’.
Context: ...tion (2FA)** Two-Factor Authentication adds an additional layer of security by requiring users to verif...
(ADD_AN_ADDITIONAL)
🪛 markdownlint-cli2 (0.18.1)
src/pages/docs/configuration/security/setup-two-factor-authentication.md
35-35: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
⏰ 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). (1)
- GitHub Check: CI
🔇 Additional comments (5)
src/pages/docs/configuration/security/okta-sso.md (1)
6-7: Metadata updates align with security section reorganization.The order and page_id updates maintain consistency with the broader restructuring of security documentation.
src/pages/docs/configuration/security/azure-sso.md (1)
6-7: Metadata updates align with security section reorganization.The order update maintains consistency with the restructured security documentation hierarchy.
src/pages/docs/configuration/security/google-sso.md (1)
6-7: Metadata updates align with security section reorganization.The order and simplified page_id maintain consistency with the restructured security documentation and improve maintainability.
src/left-nav-title.json (2)
490-490: LGTM! Appropriate label update.The label change from "Security(SSO)" to "Security" correctly reflects the broader scope of the security section, which now includes 2FA and password policy documentation beyond just SSO.
759-762: Navigation entries are properly structured with all corresponding documentation pages in place.All four entries have unique keys, descriptive labels, and correctly reference existing documentation files at the specified paths.
| "jira": {"/docs/atto/generative-ai/integrations/jira/": "Jira"}, | ||
| "xray": {"/docs/atto/generative-ai/integrations/xray/": "Xray"}, | ||
| "qtest": {"/docs/atto/generative-ai/integrations/qtest/": "qTest"} | ||
| "qtest": {"/docs/atto/generative-ai/integrations/qtest/": "qTest"}, |
There was a problem hiding this comment.
Duplicate key causes navigation mapping loss.
The key "qtest" is already defined at lines 700, 732, and 753. JSON does not allow duplicate keys at the root level—most parsers will only retain the last occurrence, causing earlier navigation entries to become unreachable.
Consolidate all qtest paths under a single key:
- "qtest": {"/docs/integrations/test-management/qtest/": "qTest"},
+ "qtest": {
+ "/docs/integrations/test-management/qtest/": "qTest",
+ "/docs/atto/generative-ai/integrations/qtest/": "qTest"
+ }Apply the same consolidation for lines 732 and 753, then remove the duplicate entry at line 758.
Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In src/left-nav-title.json around lines 700, 732, 753 and 758, the root key
"qtest" is duplicated which causes earlier mappings to be lost; consolidate all
mappings for "qtest" into a single "qtest" entry that contains every referenced
path->label pair from the entries at lines 700, 732, 753 and 758, then remove
the duplicate "qtest" entries so only one combined "qtest" key remains; ensure
the merged entry preserves all unique paths and labels exactly as they appeared.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
src/pages/docs/configuration/security/overview.md(2 hunks)src/pages/docs/configuration/security/password-policy.md(1 hunks)src/pages/docs/configuration/security/setup-two-factor-authentication.md(1 hunks)src/pages/docs/configuration/user-settings.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- src/pages/docs/configuration/security/setup-two-factor-authentication.md
- src/pages/docs/configuration/user-settings.md
⏰ 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). (1)
- GitHub Check: CI
🔇 Additional comments (3)
src/pages/docs/configuration/security/password-policy.md (1)
1-52: Documentation structure and content are clear and well-organized.The step-by-step instructions are easy to follow, with consistent S3-hosted image references. The front matter (title, page_id, order, contextual_links) is properly formatted and integrates well with the security settings documentation hierarchy.
Please verify that all S3 image URLs resolve correctly and that the page_id ordering (19.24) is appropriate relative to other security documentation pages.
src/pages/docs/configuration/security/overview.md (2)
2-27: Restructuring from SSO-focused to comprehensive Security Settings is well-executed.The rebranding appropriately broadens the scope to encompass organization-level security configurations, two-factor authentication, and password policies alongside SSO. The front matter updates (title, metadesc, page_id) and navigation structure correctly reflect this shift.
The prerequisites enhancement (line 39: "administrator access") is important and aligns with the administrative nature of security configuration.
31-75: All referenced documentation pages exist and are correctly located.Verification confirms that all six cross-referenced documentation files are present in the repository with the correct file names and paths:
- org-settings.md
- setup-two-factor-authentication.md
- password-policy.md
- google-sso.md
- okta-sso.md
- azure-sso.md
| > <p id="prerequisites">Prerequisites</p> | ||
| > | ||
| > Before you begin, ensure that you have an active Testsigma account. |
There was a problem hiding this comment.
Consider enhancing prerequisites to reflect administrator-only access.
The prerequisite currently only requires an active account. However, password policy configuration is an administrative function. The related overview.md file (line 39) specifies "administrator access" as a prerequisite. Align this documentation for consistency.
> <p id="prerequisites">Prerequisites</p>
>
-> Before you begin, ensure that you have an active Testsigma account.
+> Before you begin, ensure that:
+> 1. You have an active Testsigma account with administrator access.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > <p id="prerequisites">Prerequisites</p> | |
| > | |
| > Before you begin, ensure that you have an active Testsigma account. | |
| > <p id="prerequisites">Prerequisites</p> | |
| > | |
| > Before you begin, ensure that: | |
| > 1. You have an active Testsigma account with administrator access. |
🤖 Prompt for AI Agents
In src/pages/docs/configuration/security/password-policy.md around lines 26 to
28, the prerequisites text currently requires only an active Testsigma account
but this is an admin-only setting; update the prerequisite to require an active
Testsigma account with administrator access (or explicit administrator
privileges) to match overview.md and ensure wording is consistent with the
related docs.
2 participants
Added docs for User & Organization Settings.
Configure Organization Settings
Two-Factor Authentication (2FA)
Configure Password Policy
Configure User Settings
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.