Conversation
…ction section to address ticket
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Documentation Review
I've reviewed the SSO documentation updates and found several issues that should be addressed:
Critical Issues (2)
- Malformed callout syntax (line 119): The IMPORTANT callout has incorrect indentation that will break rendering
- Stray character in callout (line 120): An embedded ">" character disrupts the text
Formatting Issues (2)
- Inconsistent hyphenation (line 13): "set-up" should be "setup" per style guide
- Extra space in list (line 30): Bullet point has two spaces instead of one
Please see the inline comments for details and suggested fixes.
| {{< tab name="Okta SAML" >}} | ||
|
|
||
| 1. Sign in to your Okta account and open the Admin portal. | ||
| 1. Select **Administration** and then **Create App Integration**. |
| {{< tabs >}} | ||
| {{< tab name="Okta SAML" >}} | ||
|
|
||
| 1. In Okta, select your app and go to **View SAML setup instructions**. |
There was a problem hiding this comment.
Should say, In Okta, select your app, go to Sign On tab and go to View SAML setup instructions.
…configure doc from docs site, move prereqs from index to the procedures
|
/review |
There was a problem hiding this comment.
Review Summary
This PR consolidates SSO documentation by merging configure.md into connect.md. The reorganization improves document structure by combining related content, which aligns with user workflow. However, there are a few issues that need attention:
🟡 NEEDS ATTENTION
Issues Found
MEDIUM Severity
- Broken link anchor in configure-admin-console.md
LOW Severity
- Minor style guide inconsistencies in phrasing
Assessment
The documentation consolidation is valuable and the redirect aliases are properly configured. The critical issue is a broken link anchor that will send users to the wrong section. The low-severity issues are minor style improvements that would enhance clarity and consistency with Docker's style guide.
|
|
||
| - [Docker Desktop 4.37.1 or later](/manuals/desktop/release-notes.md) installed | ||
| - [A verified domain](/manuals/enterprise/security/single-sign-on/configure.md#step-one-add-and-verify-your-domain) | ||
| - [A verified domain](/manuals/enterprise/security/single-sign-on/connect.md#step-one-add-and-verify-your-domain) |
There was a problem hiding this comment.
ISSUE: Broken link anchor
The link points to connect.md#step-one-add-and-verify-your-domain but this anchor doesn't exist in the new connect.md file. The heading in connect.md is now ### Step 1: Add a domain which generates the anchor #step-1-add-a-domain.
Suggested fix:
- [A verified domain](/manuals/enterprise/security/single-sign-on/connect.md#step-1-add-a-domain)Or remove the anchor to link to the top of the page:
- [A verified domain](/manuals/enterprise/security/single-sign-on/connect.md)| 1. Copy the required values for your IdP: | ||
| ### Step 3. Create an SSO connection in Docker | ||
|
|
||
| 1. From [Docker Home](https://app.docker.com), choose your |
There was a problem hiding this comment.
Style: Awkward phrasing with 'toggle'
The phrase "toggle the Admin Console dropdown" is imprecise. According to the Docker style guide, navigation instructions should be direct and use "select" rather than action verbs like "toggle."
Suggested revision:
organization, select **Admin Console** from the dropdown, then select **SSO and SCIM** from the **Security** section.Or:
organization and select **Admin Console** > **Security** > **SSO and SCIM**.|
|
||
| {{< tabs >}} | ||
| {{< tab name="Okta SAML" >}} | ||
|
|
There was a problem hiding this comment.
Style: Could be more direct
The phrase "To enable SSO with Okta, you need..." is slightly indirect. The Docker style guide recommends removing unnecessary phrasing like "To enable" in favor of more direct language.
Suggested revision:
Enabling SSO with Okta requires [super admin](https://help.okta.com/en-us/content/topics/security/administrators-super-admin.htm) permissions for the Okta org.Or even simpler:
You need [super admin](https://help.okta.com/en-us/content/topics/security/administrators-super-admin.htm) permissions for the Okta org.| - Docker Entity ID -> **Audience URI (SP Entity ID)** | ||
| 1. Configure the following settings: | ||
| To enable SSO with Okta, you need [super admin](https://help.okta.com/en-us/content/topics/security/administrators-super-admin.htm) permissions for the Okta org. | ||
|
|
There was a problem hiding this comment.
Style: Could be more direct and consistent
The phrasing "Open the Admin portal from your Okta account and select..." could be simplified for consistency with other steps in the document.
Suggested revision:
1. In the Okta Admin portal, select **Administration**.Or:
1. Sign in to the Okta Admin portal and select **Administration**.
This PR updates SSO documentation to address inconsistencies, per tech support's jira ticket. I've made some additional changes as well: