Skip to content

Add dashboard docs: guide, Helm setup, API reference - #80

Merged
abahmed merged 4 commits into
mainfrom
docs/dashboard
Oct 28, 2026
Merged

abahmed merged 4 commits into
mainfrom
docs/dashboard

Conversation

@abahmed

@abahmed abahmed commented Oct 28, 2026

Copy link
Copy Markdown
Owner

Adds the kwatch dashboard docs (kwatch v1.2, Pro, free during early access).

Pages

  • /dashboard (Use): what the dashboard shows, turn on local in the installer, the eight ways to share with when to pick each, show/reset password, change how it's shared, turn off.
  • /dashboard-setup (Use): Helm and manual setup, pointing your own Ingress at the Service, trustProxy / tls.secretName, GitOps existingSecret.
  • /dashboard-api (Reference): auth, sign-in, rate limits, errors, /api/incidents, /api/incidents/{id}, /api/namespaces, /api/status.

Checks run: yarn typecheck, yarn build:docs, yarn seo:verify, yarn docs:verify (KWATCH_SOURCE set), yarn test:manager. static/search-index.json changed only for the three new pages.

For kwatch-designer review (new user-facing copy)

  • Page titles: "kwatch dashboard: see your issues in a browser", "kwatch dashboard setup with Helm, GitOps or your own Ingress", "kwatch dashboard API: read incidents and status over HTTP".
  • "The dashboard is a read-only web page that shows what kwatch sees ... a good page to open when someone asks 'is anything wrong?'"
  • "Local only means nothing leaves your computer."
  • "Anyone with the link and the password can read your issues, so share them only with the people who should see them."
  • Per-way sections ("Pick this when ...") mirror the installer captions.
  • "Use it only when the proxy is the only way in from outside." (outside proxy)

Not verified against code

  • Example JSON values in the API page are illustrative (for example scanEverySeconds, version).
  • Installer behaviour was read from kwatch.sh on main (Add the Dashboard menu to the installer #79) and spec sections 3 and 7c, not run against a cluster. The Tailscale and ngrok ingress mention comes from the installer code.
  • The IP allow-list is described only as available on some setups.

@abahmed
abahmed merged commit 0445937 into main Oct 28, 2026
3 checks passed
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