Updates to Workbench Documentation#206
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Up to standards ✅🟢 Issues
|
…s.yml and updates the installation.md file - it includes the steps required to make the workbench run as of 5/13/2026 with the supporting services in a UTM VM and the client running on a Mac host. The whole configuration is on the localhost
dpage
left a comment
There was a problem hiding this comment.
The substantive content here is exactly what was missing — this resolves #69. The nginx setup, the ai-dba-server -add-user step, the client file deployment, and the allow_internal_networks guidance together close the gap that made a fresh install dead-end at the login page, so I'd love to see this land.
A few documentation-style nits below before un-drafting — none of them are blockers, just cleanup:
-
Broken cross-reference. The "Using Binary Files to Install Workbench" section links to
docs/getting-started/quick-start.md, but that file isn't in this PR and doesn't exist in the docs tree, so it will 404 once the site is built. Either add the page, or repoint the cross-reference at the binary-install steps already in this file. -
Hard-coded versioned external links. The
secret_file/password_filebullets in "Building AI DBA Workbench from Source Code" point athttps://docs.pgedge.com/ai-dba-workbench/v1-0-0-beta1/.... These will rot at the next release. The style guide prefers local relative links when one is available —configuration/collector.md#security-optionsetc. would survive version bumps for free. -
User=placeholder vs. RPM/DEB row. The three systemd unit examples now useUser=user_name, but the deployment-paths table two paragraphs earlier still documentsRun-as user: pgedgefor the RPM/DEB column. Keepinguser_nameas the placeholder is right for the GitHub-release method this section is documenting — but it's worth one short note that the RPM/DEB packages create and use thepgedgeuser automatically, so package-method installers shouldn't hand-edit the unit files. -
Sample
systemctl statusoutput. The collector/alerter status blocks bake in a specific hostname (n1), the beta version string (v1.0.0-beta1), and concrete timestamps. The style guide says sample output should match actual output, which is fine if these were captured from a real run — just want to confirm they weren't hand-written, and flag that thev1.0.0-beta1string in particular will go stale at release. -
Duplicated verification content. The new
docs/getting-started/verify_health.md(Checking the Collector / Server / Alerter / Metrics Collection) is essentially the same content as the new "Verifying the State of Individual Components" section ininstallation.md. Two copies will drift. Suggest keepingverify_health.mdas the canonical home and replacing the duplicated section ininstallation.mdwith a short pointer to it — bonus, it keepsinstallation.mdfrom growing too long.
Thanks for tackling this — the install path is meaningfully better with these changes.
…ction to include overview page; renamed files
Updating documentation for consistency, etc...