Skip to content

Add overview pages for org setup and manage sections#25580

Open
akristen wants to merge 2 commits into
docker:mainfrom
akristen:manage-index-page
Open

Add overview pages for org setup and manage sections#25580
akristen wants to merge 2 commits into
docker:mainfrom
akristen:manage-index-page

Conversation

@akristen

Copy link
Copy Markdown
Contributor

Summary

The admin > organization Setup and Manage section landing pages
(_index.md) were hidden stubs (build: render: never). Because Hugo doesn't
publish those pages, the sidebar rendered both sections as non-clickable,
expand-only entries. This PR turns them into proper overview pages that follow
the pattern used by sibling section overviews (Organization, Company, etc.).

  • Add front matter (title, linkTitle, description, keywords) and a grid
    of child-page cards to both pages, so they render and become clickable in the
    sidebar.
  • Add a short overview of the setup phases (create/convert, onboard, maintain)
    that clarifies which tasks are sequential and which aren't.
  • Add a seats-vs-licenses comparison table to the Manage overview to distinguish
    the two entitlements.

The admin > organization > setup and manage _index pages were hidden
stubs (build: render: never), so the sidebar rendered them as
non-clickable expand-only entries. Turn them into landing pages that
follow the pattern used by sibling section overviews.

- Add title, linkTitle, description, keywords, and a grid of child-page
  cards to both pages so they render and become clickable in the sidebar
- Add a short overview of the setup phases (create/convert, onboard,
  maintain), noting which tasks are sequential and which are not
- Add a seats-vs-licenses comparison table to the manage overview to
  clarify the distinction between the two entitlements

Co-authored-by: Cursor <cursoragent@cursor.com>
@akristen akristen self-assigned this Jul 16, 2026
@akristen akristen added the area/admin Relates to Docker Admin label Jul 16, 2026
@netlify

netlify Bot commented Jul 16, 2026

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 006d51a
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6a58e380ba7b7f000874887a
😎 Deploy Preview https://deploy-preview-25580--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.

Wrap prose to 80 characters and tighten wording across the org setup and manage overview pages. Replace a semicolon with two sentences, remove parentheses and redundant phrasing, and fix awkward wording for clarity and style-guide compliance.

Co-authored-by: Cursor <cursoragent@cursor.com>
@akristen
akristen marked this pull request as ready for review July 16, 2026 13:58
@akristen
akristen requested a review from aevesdocker July 16, 2026 13:58

@docker-agent docker-agent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Assessment: 🟢 APPROVE

All findings are low-severity style suggestions. No breaking issues were found. The front matter, grid shortcode usage, and page structure correctly follow the established pattern used by sibling section overview pages.

1. You can create a new organization, or convert an existing user account
into one. Choose the option that fits how you already use Docker. You
don't need both.
1. After creating your organization, you must onboard it by inviting members,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LOW] Redundant phrase: "whenever it changes at any time"

"At any time" is redundant with "whenever it changes" — both convey the same idea. Consider:

You can update your organization's general information whenever it changes.

## Setting up your organization

You set up your organization from [Docker Home](https://app.docker.com) and
must be assigned the

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LOW] Vague transitional phrase "in broad phases"

"In broad phases" is vague. Per Docker style, prefer direct, specific language. Consider:

Setting up an organization involves these steps:

and product usage. You can invite members, group them into teams, assign or
revoke licenses and seats, and change access to Docker products.

## Managing your organization

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LOW] Heading "Managing your organization" restates the page title

The heading ## Managing your organization closely mirrors the page title "Manage your organization" and contains only a single sentence. Per Docker style guidelines, headings should add value beyond restating the title. Consider removing this heading and folding the sentence into the opening paragraph, or replacing it with a more specific heading (e.g., "Prerequisites").

@docker-agent docker-agent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Assessment: 🟢 APPROVE

Both new overview pages are well-structured and follow the established sibling section pattern. Required front matter (title, description, keywords) is present in both files, build: render: never is correctly removed, no redirects are needed (the old stubs were never published), and there are no AI-isms, no bold misuse, and no markdown errors.

Minor style observations (no action required):

  • ## Setting up your organization (setup/_index.md:38) and ## Managing your organization (manage/_index.md:30) use a gerund form and mirror the page title — a more descriptive heading like ## Setup phases / ## Management tasks would add more navigational value, but this is a minor point.
  • "Explore the following sections to set up/manage your organization." (setup/_index.md:55, manage/_index.md:51) is light meta-commentary that STYLE.md suggests dropping — the grid shortcode stands on its own without a lead-in sentence.

These are low-priority observations; the pages are ready to publish as-is.

@docker-agent docker-agent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Assessment: 🟢 APPROVE

The PR promotes two previously hidden (build: render: never) organization landing pages into fully published overview pages. The changes follow established patterns in the codebase:

  • Front matter is complete (title, linkTitle, description, keywords, grid)
  • Grid tile links use the correct short URL convention (no /manuals/ prefix)
  • Body-text internal links use the established /manuals/ prefix convention, consistent with 100+ sibling files
  • No aliases/redirects needed — the pages were never previously published
  • No AI-isms, marketing language, or style guide violations detected
  • Hugo shortcode usage ({{< grid >}}) is correct
  • Scope is well-matched to the document type (section overview/landing page)

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.

2 participants