[docs-scanner] SSO setup steps mismatch between overview and procedure

Open Beginner friendly
#26,091 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
92/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
docker
Domain
documentation

Research direction

Start with content/manuals/security/authentication/single-sign-on/_index.md and compare its “Set up SSO” list with connect.md. Update the overview to reflect the six procedure steps, then present provisioning, enforcement, and management as post-setup tasks rather than numbered setup steps.

Written by the indexing model from the issue text.

Description

File: content/manuals/security/authentication/single-sign-on/_index.md

Issue

The "Set up SSO" section in the overview lists steps that don't match the actual procedure in connect.md:

Overview (_index.md) lists:

  1. Configure your domain by creating and verifying it.
  2. Create your SSO connection in Docker and your IdP.
  3. Link Docker to your identity provider.
  4. Test your SSO connection.
  5. Provision users in Docker.
  6. Optional. Enforce sign-in.
  7. Manage your SSO configuration.

But the actual procedure in connect.md has:

  • Step 1: Add a domain
  • Step 2: Verify your domain
  • Step 3: Create an SSO connection in Docker
  • Step 4: Create an SSO connection in your IdP
  • Step 5: Connect Docker to your IdP
  • Step 6: Test the connection
Why this matters

Readers following the overview expect 7 steps but the actual guide has 6 steps with different groupings. The overview mentions "Provision users in Docker" as step 5, but this isn't part of the core setup procedure in connect.md (it's mentioned in "Next steps" instead). The overview's step 3 "Link Docker to your identity provider" is actually covered by steps 4-5 in the real procedure. This mismatch would confuse readers trying to understand what the setup process involves.

Suggested fix

Update the overview in _index.md to accurately reflect the actual steps in connect.md:

  1. Add a domain
  2. Verify your domain
  3. Create an SSO connection in Docker
  4. Create an SSO connection in your IdP
  5. Connect Docker to your IdP
  6. Test the connection

Then mention provisioning, enforcement, and management as post-setup tasks rather than numbered setup steps.

Found by nightly documentation quality scanner

Dominant language
Markdown
Stars
4.7k
Forks
8.5k
Avg merge
2d 12h
Merged PRs (30d)
104

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from docker/docs

All issues in docker/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.