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.
…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.
.../manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md
Outdated
Show resolved
Hide resolved
aevesdocker
left a comment
There was a problem hiding this comment.
Much more efficient! Some small nits only
| build: | ||
| render: never | ||
| title: FAQs | ||
| weight: 3 |
There was a problem hiding this comment.
Nit: we tend to go up in blocks of 10 (don't ask why, we just do)
| linkTitle: Manage | ||
| title: Manage SSO domains and connections | ||
| linkTitle: Manage connections | ||
| weight: 2 |
| linkTitle: Connect | ||
| title: Set up single sign-on | ||
| linkTitle: Set up | ||
| weight: 1 |
Co-authored-by: Alexa Kristensen <81787716+akristen@users.noreply.github.com> Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
This PR updates SSO documentation to address inconsistencies, per tech support's jira ticket. I've made some additional changes as well: