Skip to content

docs: add dashboard access to quickstart - #22

Merged
STRRL merged 1 commit into
masterfrom
docs/dashboard-quickstart
Jul 26, 2026
Merged

docs: add dashboard access to quickstart#22
STRRL merged 1 commit into
masterfrom
docs/dashboard-quickstart

Conversation

@STRRL

@STRRL STRRL commented Jul 26, 2026

Copy link
Copy Markdown
Owner

Problem

The quickstart does not explain how to access the built-in Dashboard.

Solution

Add Dashboard Service checks, local access commands, API verification, and the release requirement.

Major Changes

  • Dashboard access
    • Document the Service, port forward, browser URL, and projects API
    • Explain the ClusterIP and authentication boundary
  • Release guidance
    • State that version 2026.7.25 does not include the Dashboard

Part of #18

@STRRL
STRRL marked this pull request as ready for review July 26, 2026 23:34
@STRRL
STRRL merged commit a6c6f2c into master Jul 26, 2026
3 checks passed
@STRRL
STRRL deleted the docs/dashboard-quickstart branch July 26, 2026 23:34

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b103ae92cf

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/quickstart.md
Comment on lines +110 to +112
Version `2026.7.25` is the verified Phase A release. It does not include the
Dashboard. Use a later release that includes the Dashboard before following
step 6.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Pin a release that actually contains the Dashboard

When a reader follows the quickstart verbatim, step 3 still installs 2026.7.25, so the Dashboard Service documented in step 6 will not exist and the kubectl get/port-forward commands will fail. Telling readers to use an unspecified later release does not provide an executable path; update the install command to a concrete Dashboard-enabled release, or add an explicit upgrade command once that release is available.

Useful? React with 👍 / 👎.

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.

1 participant