Skip to content

Updates to Workbench Documentation#206

Draft
susan-pgedge wants to merge 5 commits into
mainfrom
doc_review
Draft

Updates to Workbench Documentation#206
susan-pgedge wants to merge 5 commits into
mainfrom
doc_review

Conversation

@susan-pgedge
Copy link
Copy Markdown
Member

Updating documentation for consistency, etc...

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 3ee5f551-5c5f-48ce-b6b6-ce8893afd14c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch doc_review

Comment @coderabbitai help to get the list of available commands and usage tips.

@codacy-production
Copy link
Copy Markdown

codacy-production Bot commented May 7, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

Susan Douglas added 2 commits May 12, 2026 12:09
…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
@susan-pgedge susan-pgedge requested a review from dpage May 13, 2026 15:38
Copy link
Copy Markdown
Member

@dpage dpage left a comment

Choose a reason for hiding this comment

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

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:

  1. 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.

  2. Hard-coded versioned external links. The secret_file / password_file bullets in "Building AI DBA Workbench from Source Code" point at https://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-options etc. would survive version bumps for free.

  3. User= placeholder vs. RPM/DEB row. The three systemd unit examples now use User=user_name, but the deployment-paths table two paragraphs earlier still documents Run-as user: pgedge for the RPM/DEB column. Keeping user_name as 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 the pgedge user automatically, so package-method installers shouldn't hand-edit the unit files.

  4. Sample systemctl status output. 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 the v1.0.0-beta1 string in particular will go stale at release.

  5. 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 in installation.md. Two copies will drift. Suggest keeping verify_health.md as the canonical home and replacing the duplicated section in installation.md with a short pointer to it — bonus, it keeps installation.md from growing too long.

Thanks for tackling this — the install path is meaningfully better with these changes.

Comment thread docs/getting-started/installation.md Outdated
Comment thread docs/getting-started/installation.md Outdated
Comment thread docs/getting-started/installation.md Outdated
Comment thread docs/getting-started/installation.md Outdated
Comment thread docs/getting-started/installation.md Outdated
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.

2 participants