Skip to content

[docs] Make Quickstart container checks explicit - #4434

Open
wuchong wants to merge 1 commit into
apache:mainfrom
wuchong:docs/quickstart-container-count-check
Open

wuchong wants to merge 1 commit into
apache:mainfrom
wuchong:docs/quickstart-container-count-check

Conversation

@wuchong

@wuchong wuchong commented Sep 20, 2026

Copy link
Copy Markdown
Member

Purpose

Linked issue: close #4433

Make Quickstart startup verification easier to interpret. A plain docker compose ps table can make failed or missing containers easy to overlook, especially when the stack also has services that are expected to exit.

Generative AI disclosure: Yes — Codex (gpt-5).

Brief change log

  • Count the expected long-running containers in each Docker Compose Quickstart.
  • Document the expected count for each stack.
  • Exclude the one-shot rustfs-init and interactive sql-client services where appropriate.
  • Point users to docker compose ps -a when the count is lower than expected.

Tests

  • ./mvnw -N -B verify spotless:check
  • npm run typecheck
  • CI=true npm run build -- --no-minify
  • Parsed all six embedded Compose definitions with docker compose config --no-interpolate --services.

API and Format

No API or storage format changes.

Documentation

This is a documentation-only change.

Count the expected long-running containers in each Quickstart stack and point users to the full Compose status when the count is lower.

Co-Authored-By: Codex <noreply@openai.com>
AI-Model: gpt-5
AI-Contributed/Feature: 71/71
AI-Contributed/UT: 0/0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Make Quickstart container startup checks explicit

1 participant