Conversation
…ction section to address ticket
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
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.
| Setting up a single sign-on (SSO) connection involves configuring both Docker | ||
| and your identity provider (IdP). This guide walks you through setup | ||
| in Docker, setup in your IdP, and final connection. | ||
| and your identity provider (IdP). This guide walks you through set-up |
There was a problem hiding this comment.
Inconsistent noun hyphenation
The word appears as "set-up" in "This guide walks you through set-up". Per STYLE.md, hyphens are used for compound adjectives before nouns (e.g., "up-to-date documentation"), not for nouns themselves. In this context, "set-up" is a noun and should be "setup" without hyphenation.
Suggested fix: Change "set-up" to "setup" on both lines 13 and 14.
| If you're using a | ||
| used providers: Okta and Microsoft Entra ID. If you're using a | ||
| different IdP, the general process remains the same: | ||
|
|
There was a problem hiding this comment.
Extra space in bullet list item
This line has "- Complete..." with two spaces after the dash. Adjacent bullet points on lines 28-29 and 31 use a single space after the dash.
Suggested fix: Change "- Complete" to "- Complete" (single space after dash).
| ### Connect Docker to your IdP | ||
|
|
||
| Complete the integration by pasting your IdP values into Docker. | ||
|
|
There was a problem hiding this comment.
The IMPORTANT callout has improper indentation with 4 spaces before the ">" character on continuation lines. Per COMPONENTS.md, callout syntax requires each line to start with "> " without any leading spaces.
Current format (broken):
> [!IMPORTANT]
>
> When prompted to copy...Correct format:
> [!IMPORTANT]
>
> When prompted to copy a certificate, copy the entire certificate starting with `----BEGIN CERTIFICATE----` and including the `----END CERTIFICATE----` lines.This syntax error will prevent the callout from rendering correctly.
|
|
||
| Complete the integration by pasting your IdP values into Docker. | ||
|
|
||
| > [!IMPORTANT] |
There was a problem hiding this comment.
Line 120 contains "starting > with" where a stray ">" character appears embedded in the text. This should read "starting with ----BEGIN CERTIFICATE----" without the embedded ">".
This appears to be related to the malformed callout syntax on line 119. When fixing the callout indentation, this stray character should also be removed.
1 participant
This PR updates SSO documentation to address inconsistencies, per tech support's jira ticket. I've made some additional changes as well:
Work that needs to be done:
While I personally don't prefer titles with "Step 1: jfdsfjsdf", I'm more than happy to defer if we think it'll help users understand the sequence as linear!! :) lmk