Skip to content

SSO doc updates #24129

Open
akristen wants to merge 17 commits intodocker:mainfrom
akristen:sso-updates
Open

SSO doc updates #24129
akristen wants to merge 17 commits intodocker:mainfrom
akristen:sso-updates

Conversation

@akristen
Copy link
Contributor

@akristen akristen commented Feb 10, 2026

This PR updates SSO documentation to address inconsistencies, per tech support's jira ticket. I've made some additional changes as well:

  • I've removed 4/5ish call outs throughout the doc. Callouts lose effectiveness if you use them often.
  • I've condensed certain redundant UI steps like "Save", "Finish", "Select X" and created more compound steps. This shortens the procedures and simplifies the ~weight of each substep.
  • Merged Configure and Connect docs into one. Having 1 doc for two steps when they're necessary for the overall action risks losing users and adding confusion.
  • I've added Prerequisites from the index page to the actual procedures. Prereqs should always be associated closely with the action users are taking after establishing those pre-requisites.

@netlify
Copy link

netlify bot commented Feb 10, 2026

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 4f23cf9
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/69c431a1e3495b0008452798
😎 Deploy Preview https://deploy-preview-24129--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@akristen akristen self-assigned this Feb 10, 2026
@akristen akristen added the area/admin Relates to Docker Admin label Feb 10, 2026
@akristen akristen marked this pull request as ready for review February 13, 2026 15:13
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

gonzo919

This comment was marked as resolved.

…configure doc from docs site, move prereqs from index to the procedures
@akristen
Copy link
Contributor Author

/review

Copy link
Contributor

@docker-agent docker-agent bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@akristen akristen requested a review from serjkarneichyk March 24, 2026 19:44
Copy link
Contributor

@aevesdocker aevesdocker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much more efficient! Some small nits only

build:
render: never
title: FAQs
weight: 3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit

linkTitle: Connect
title: Set up single sign-on
linkTitle: Set up
weight: 1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit

Co-authored-by: Alexa Kristensen <81787716+akristen@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/admin Relates to Docker Admin

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants