Skip to content

Adding configuration details for AI Workbench to PEP content#100

Merged
susan-pgedge merged 7 commits into
mainfrom
pep_workbench
Jun 10, 2026
Merged

Adding configuration details for AI Workbench to PEP content#100
susan-pgedge merged 7 commits into
mainfrom
pep_workbench

Conversation

@susan-pgedge

@susan-pgedge susan-pgedge commented May 26, 2026

Copy link
Copy Markdown
Member

Added deployment/configuration pages.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Debian and RPM installation and configuration guides for the AI DBA Workbench, covering prerequisites, package installation, database setup, component configuration, service startup, and web console access (with screenshots).
    • Updated site navigation to include the new Workbench guides.
    • Added a dated deployments entry noting Workbench configuration details.

@coderabbitai

coderabbitai Bot commented May 26, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

Adds Debian and RPM installation/configuration guides for the pgEdge AI DBA Workbench, updates mkdocs navigation to link those pages, and adds a 05/26/2026 deployments.md entry noting the new documentation.

Changes

pgEdge AI DBA Workbench Installation Guides

Layer / File(s) Summary
Prerequisites and PostgreSQL 18 installation
docs/enterprise/debian/components/workbench.md, docs/enterprise/el/components/workbench.md
Prerequisites and PostgreSQL 18 setup via apt (Debian) and dnf (EL), including repo configuration, init/enable, password setup, and ai_workbench database creation.
Workbench package installation
docs/enterprise/debian/components/workbench.md, docs/enterprise/el/components/workbench.md
Installs pgedge-ai* packages via apt/dnf, showing expected dependency outputs (including nginx and related packages).
Collector component setup
docs/enterprise/debian/components/workbench.md, docs/enterprise/el/components/workbench.md
Creates dba_collector role, enables extensions, grants schema/table/sequence privileges, edits ai-dba-collector.yaml, generates and secures collector secret, and starts collector service.
MCP server component setup
docs/enterprise/debian/components/workbench.md, docs/enterprise/el/components/workbench.md
Creates dba_server role with required grants, edits ai-dba-server.yaml (datastore and AI provider/LLM/embedding examples), copies/locks shared secret, creates admin user and API token via ai-dba-server, fixes auth.db ownership, and starts server service.
Alerter component setup
docs/enterprise/debian/components/workbench.md, docs/enterprise/el/components/workbench.md
Creates dba_alerter role with required grants, edits ai-dba-alerter.yaml, and starts alerter service.
Web console deployment and access
docs/enterprise/debian/components/workbench.md, docs/enterprise/el/components/workbench.md
Start Nginx, apply SELinux port/boolean updates on EL, and access the web console at http://localhost:8444/.
Documentation navigation and deployment metadata
mkdocs.yml, deployments.md
Adds mkdocs navigation entries for EL and Debian workbench guides and a 05/26/2026 deployments.md log entry noting the AI Workbench documentation.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • dpage
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding AI Workbench configuration documentation to the PEP content across multiple deployment guides and navigation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch pep_workbench

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

@codacy-production

codacy-production Bot commented May 26, 2026

Copy link
Copy Markdown

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.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented May 26, 2026

Copy link
Copy Markdown

Deploying pgedge-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: a32eef3
Status: ✅  Deploy successful!
Preview URL: https://8c8ba00a.pgedge-docs.pages.dev
Branch Preview URL: https://pep-workbench.pgedge-docs.pages.dev

View logs

@susan-pgedge susan-pgedge requested review from dpage and imtiazqa May 28, 2026 13:56
@susan-pgedge susan-pgedge marked this pull request as ready for review May 28, 2026 13:59

@coderabbitai coderabbitai 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.

Actionable comments posted: 6

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/enterprise/debian/components/workbench.md`:
- Around line 609-611: The SQL grant is targeting alert_acknowledgments but the
intent and comment reference notification_history; update the GRANT statement so
it grants the required privileges on the correct table (notification_history)
for the dba_alerter role (e.g., change "GRANT SELECT, INSERT, UPDATE, DELETE ON
alert_acknowledgments TO dba_alerter;" to target notification_history) and
ensure the surrounding comment/heading still reflects "notification_history:
Track notifications".
- Line 444: Remove the full token-looking secret string in
docs/enterprise/debian/components/workbench.md (the Token:
VyGrZzGFUdiZeLZcCTrMR3Nnh2LrqyckpAcmpxlU0= line) and replace it with a
non-sensitive placeholder or clearly redacted example (e.g., Token:
<REDACTED_TOKEN> or Token: example-XXXXXXXX-XXXX) so the document no longer
includes a copy-pastable secret; ensure the replacement keeps the same
context/formatting and add a short note if needed that real tokens must be
generated via the service.
- Around line 165-176: The YAML example is malformed: keys database, Username,
port, sslmode, and password must be nested under the top-level datastore mapping
and the Username key should use consistent lowercase `user` to match other
examples; update the block so that `datastore:` contains host, database, user,
port, sslmode, and password indented beneath it (preserve values like
ai_workbench and 5432) and change `Username` → `user`.

In `@docs/enterprise/el/components/workbench.md`:
- Line 456: Update the sample output line that begins with "Token:" to remove
the full token value and replace it with a redacted placeholder (e.g. "Token:
<REDACTED>" or "Token: REDACTED_TOKEN") so the docs no longer contain a full
token-looking secret; locate the "Token:" sample output entry in workbench.md
and change only the value portion to a non-secret placeholder while preserving
surrounding formatting.
- Around line 621-623: The GRANT statement mistakenly targets
alert_acknowledgments while the comment/label says notification_history; update
the SQL so the GRANT SELECT, INSERT, UPDATE, DELETE is applied to the
notification_history table (replace alert_acknowledgments with
notification_history) for the dba_alerter role so the permissions align with the
"notification_history: Track notifications" intent.
- Around line 177-188: The YAML snippet under the datastore example is
malformed: keys database, Username, port, sslmode, and password are not nested
under the datastore mapping and the Username key uses inconsistent casing;
update the snippet so all connection keys (host, database, user, port, sslmode,
password) are children of datastore and rename Username to user (lowercase) to
match other examples; ensure proper YAML indentation and consistent key names so
the example will parse as a valid datastore configuration.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 65b71427-c46a-400c-8152-3f0f1c777f39

📥 Commits

Reviewing files that changed from the base of the PR and between a9adeb6 and 0fa9a19.

📒 Files selected for processing (4)
  • deployments.md
  • docs/enterprise/debian/components/workbench.md
  • docs/enterprise/el/components/workbench.md
  • mkdocs.yml

Comment thread docs/enterprise/debian/components/workbench.md
Comment thread docs/enterprise/debian/components/workbench.md
Comment thread docs/enterprise/debian/components/workbench.md Outdated
Comment thread docs/enterprise/el/components/workbench.md
Comment thread docs/enterprise/el/components/workbench.md
Comment thread docs/enterprise/el/components/workbench.md Outdated

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/enterprise/debian/components/workbench.md`:
- Line 5: Replace the misspelled word "installating" in the intro sentence with
"installing" so the sentence reads "...installing PostgreSQL 18, the Workbench
components, and the Nginx web..."; update the occurrence of "installating" in
workbench.md accordingly to fix the user-facing typo.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: cde9dacf-fcde-442e-8755-d854470815f5

📥 Commits

Reviewing files that changed from the base of the PR and between 0fa9a19 and 872b2b4.

📒 Files selected for processing (1)
  • docs/enterprise/debian/components/workbench.md

Comment thread docs/enterprise/debian/components/workbench.md Outdated
Corrected typos and improved formatting in the installation guide and SQL grant statements.
Added necessary grants for notification_history and notification_reminder_state.

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

♻️ Duplicate comments (3)
docs/enterprise/el/components/workbench.md (3)

622-622: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix the mislabeled GRANT target under notification_history.

Line 622 still grants permissions on alert_acknowledgments while the section is for notification_history; this makes the SQL block internally inconsistent.

Suggested fix
--- notification_history: Track notifications
-GRANT SELECT, INSERT, UPDATE, DELETE ON alert_acknowledgments TO dba_alerter;
+GRANT SELECT, INSERT, UPDATE, DELETE ON TABLE notification_history TO dba_alerter;
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/enterprise/el/components/workbench.md` at line 622, The GRANT statement
in the SQL block is granting permissions on alert_acknowledgments but the
section is about notification_history; update the SQL GRANT line so it targets
notification_history instead of alert_acknowledgments (i.e., change "GRANT ...
ON alert_acknowledgments TO dba_alerter;" to grant on notification_history) so
the block and section are consistent.

177-188: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Collector YAML example is still malformed.

Connection keys remain outside datastore, and Username casing is inconsistent with the rest of the doc examples.

Suggested fix
 datastore:
   # Hostname or IP address of the AI DBA Workbench datastore PostgreSQL
   # server. Default: localhost. Command-line: -pg-host
   host: localhost
-
-database: ai_workbench
-Username: dba_collector
-port: 5432
-sslmode: disable
-password: 1safepassword!
+  database: ai_workbench
+  user: dba_collector
+  port: 5432
+  sslmode: disable
+  password: "1safepassword!"
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/enterprise/el/components/workbench.md` around lines 177 - 188, The YAML
example is malformed: move the connection entries (database, username, port,
sslmode, password) into the existing datastore mapping so they are nested under
datastore, and normalize the key casing (change "Username" to "username") to
match other examples; update the block under the datastore mapping (host: ...)
to include database, username, port, sslmode, and password as child keys of
datastore (preserving values shown) so the YAML is valid and consistent with
other docs.

456-456: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Redact the token value in sample output.

A full token-like secret is still published in the docs output.

Suggested fix
-Token: VyGrZzGFUdiZeLZcCTrMR3Nnh2LrqyckpAcmpxlU0=
+Token: <REDACTED>
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/enterprise/el/components/workbench.md` at line 456, The sample output
contains a full secret-like string after the "Token:" label; replace the exposed
token value with a placeholder (e.g. "<REDACTED_TOKEN>" or a truncated form like
"VyGrZz...U0=") in the sample output block so no real secret is published —
locate the "Token:" line in the workbench.md sample output and update it to
redact or truncate the token value.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/enterprise/el/components/workbench.md`:
- Around line 624-625: The notification grants are duplicated: remove the
redundant GRANT statements so each object has a single canonical grant;
specifically keep one GRANT SELECT, INSERT, UPDATE, DELETE ON TABLE
notification_history TO dba_alerter and one GRANT USAGE, SELECT ON SEQUENCE
notification_history_id_seq TO dba_alerter and delete the overlapping duplicate
lines (the extra notification_history table grant and the extra sequence grant),
ensuring only one grant per table/sequence remains in the section.

---

Duplicate comments:
In `@docs/enterprise/el/components/workbench.md`:
- Line 622: The GRANT statement in the SQL block is granting permissions on
alert_acknowledgments but the section is about notification_history; update the
SQL GRANT line so it targets notification_history instead of
alert_acknowledgments (i.e., change "GRANT ... ON alert_acknowledgments TO
dba_alerter;" to grant on notification_history) so the block and section are
consistent.
- Around line 177-188: The YAML example is malformed: move the connection
entries (database, username, port, sslmode, password) into the existing
datastore mapping so they are nested under datastore, and normalize the key
casing (change "Username" to "username") to match other examples; update the
block under the datastore mapping (host: ...) to include database, username,
port, sslmode, and password as child keys of datastore (preserving values shown)
so the YAML is valid and consistent with other docs.
- Line 456: The sample output contains a full secret-like string after the
"Token:" label; replace the exposed token value with a placeholder (e.g.
"<REDACTED_TOKEN>" or a truncated form like "VyGrZz...U0=") in the sample output
block so no real secret is published — locate the "Token:" line in the
workbench.md sample output and update it to redact or truncate the token value.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 796cc628-b97c-4647-9c48-0b99a24f894d

📥 Commits

Reviewing files that changed from the base of the PR and between d963b44 and 38f2413.

📒 Files selected for processing (1)
  • docs/enterprise/el/components/workbench.md

Comment thread docs/enterprise/el/components/workbench.md

@coderabbitai coderabbitai 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.

Actionable comments posted: 2

♻️ Duplicate comments (6)
docs/enterprise/debian/components/workbench.md (3)

172-183: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix malformed collector datastore YAML (keys are not nested).

database, Username, port, sslmode, and password must be nested under datastore, and Username should be normalized (username/user) to match the rest of the docs.

Suggested fix
 datastore:
   # Hostname or IP address of the AI DBA Workbench datastore PostgreSQL
   # server. Default: localhost. Command-line: -pg-host
   host: localhost
-
-database: ai_workbench
-Username: dba_collector
-port: 5432
-sslmode: disable
-password: 1safepassword!
+  database: ai_workbench
+  username: dba_collector
+  port: 5432
+  sslmode: disable
+  password: "1safepassword!"
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/enterprise/debian/components/workbench.md` around lines 172 - 183, The
YAML block currently has top-level keys that should be nested under datastore
and the Username key is capitalized; move database, username (normalize
"Username" to lower-case "username" or "user" to match docs), port, sslmode, and
password inside the existing datastore mapping so the structure becomes
datastore: { host: ..., database: ..., username: ..., port: ..., sslmode: ...,
password: ... }; ensure key names exactly match the rest of the docs (use
"username" or "user" consistently) and keep host under datastore as shown.

574-578: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Remove the incorrect/duplicate alerter GRANT in notification history section.

Under -- notification_history: Track notifications, the grant to alert_acknowledgments is inconsistent and duplicates intent already covered by the correct notification_history grant.

Suggested fix
 -- notification_history: Track notifications
-GRANT SELECT, INSERT, UPDATE, DELETE ON alert_acknowledgments TO dba_alerter;
-
 GRANT SELECT, INSERT, UPDATE, DELETE ON TABLE notification_history TO dba_alerter;
 GRANT USAGE, SELECT ON SEQUENCE notification_history_id_seq TO dba_alerter;
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/enterprise/debian/components/workbench.md` around lines 574 - 578,
Remove the incorrect duplicate GRANT for alert_acknowledgments found under the
-- notification_history: Track notifications section: delete the line "GRANT
SELECT, INSERT, UPDATE, DELETE ON alert_acknowledgments TO dba_alerter;" so only
the intended grants for notification_history (the GRANT on TABLE
notification_history and the GRANT on SEQUENCE notification_history_id_seq)
remain.

453-453: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Redact the token value in sample output.

Publishing a full token-like string in docs should be avoided; replace it with a placeholder.

Suggested fix
-Token: VyGrZzGFUdiZeLZcCTrMR3Nnh2LrqyckpAcmpxlU0=
+Token: <REDACTED_TOKEN>
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/enterprise/debian/components/workbench.md` at line 453, The sample
output contains a real-looking token
"VyGrZzGFUdiZeLZcCTrMR3Nnh2LrqyckpAcmpxlU0=" which should be redacted; locate
that literal token in the workbench sample output and replace it with a generic
placeholder such as <REDACTED_TOKEN> or TOKEN_PLACEHOLDER, and update any
adjacent explanatory text to reflect that the value is an example placeholder
rather than a real token.
docs/enterprise/el/components/workbench.md (3)

457-457: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Redact the token value in sample output.

Replace the token-like value with a placeholder to avoid leaking reusable-looking secrets in docs.

Suggested fix
-Token: VyGrZzGFUdiZeLZcCTrMR3Nnh2LrqyckpAcmpxlU0=
+Token: <REDACTED_TOKEN>
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/enterprise/el/components/workbench.md` at line 457, Replace the
hard-coded token-like string "VyGrZzGFUdiZeLZcCTrMR3Nnh2LrqyckpAcmpxlU0=" in the
sample output with a non-sensitive placeholder (e.g., "<REDACTED_TOKEN>" or
"<SAMPLE_TOKEN>") so the docs no longer expose a reusable-looking secret; update
the sample output in workbench.md where that token appears and ensure any
surrounding text still makes sense with the placeholder.

578-582: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Remove the incorrect/overlapping GRANT in notification history section.

The alert_acknowledgments GRANT under the notification_history heading is inconsistent and redundant with the explicit notification_history grant below.

Suggested fix
 -- notification_history: Track notifications
-GRANT SELECT, INSERT, UPDATE, DELETE ON alert_acknowledgments TO dba_alerter;
-
 GRANT SELECT, INSERT, UPDATE, DELETE ON TABLE notification_history TO dba_alerter;
 GRANT USAGE, SELECT ON SEQUENCE notification_history_id_seq TO dba_alerter;
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/enterprise/el/components/workbench.md` around lines 578 - 582, Remove
the incorrect/redundant GRANT for alert_acknowledgments that appears under the
notification_history section: delete the line "GRANT SELECT, INSERT, UPDATE,
DELETE ON alert_acknowledgments TO dba_alerter;" so only the correct grants for
notification_history and notification_history_id_seq (i.e., "GRANT SELECT,
INSERT, UPDATE, DELETE ON TABLE notification_history TO dba_alerter;" and "GRANT
USAGE, SELECT ON SEQUENCE notification_history_id_seq TO dba_alerter;") remain
in that section.

182-193: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix malformed collector datastore YAML (keys are not nested).

database, Username, port, sslmode, and password must be under datastore, and casing should be consistent with other examples.

Suggested fix
 datastore:
   # Hostname or IP address of the AI DBA Workbench datastore PostgreSQL
   # server. Default: localhost. Command-line: -pg-host
   host: localhost
-
-database: ai_workbench
-Username: dba_collector
-port: 5432
-sslmode: disable
-password: 1safepassword!
+  database: ai_workbench
+  username: dba_collector
+  port: 5432
+  sslmode: disable
+  password: "1safepassword!"
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/enterprise/el/components/workbench.md` around lines 182 - 193, The YAML
example has top-level keys that should be nested under the datastore mapping and
uses inconsistent casing; move database, username, port, sslmode, and password
under the existing datastore key, align their indentation so they are children
of datastore, and normalize key names to lowercase (e.g., username) to match
other examples (update the YAML block in workbench.md where the datastore
example appears).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/enterprise/debian/components/workbench.md`:
- Line 76: The admonition uses an indented code-style for the psql example (the
line containing `\q` / the phrase "psql client session") which triggers
markdownlint MD046; replace the indented code block with a fenced code block
(``` or ```psql) or convert to inline code if it’s a single inline token, and
make the same change for the other occurrence that mentions `\q` (the second
admonition containing the same psql/`\q` text).

In `@docs/enterprise/el/components/workbench.md`:
- Line 74: Replace the indented code-style inside the admonition that contains
"You can use `\q` to exit the `psql` client session and return to the" with a
fenced code block (triple backticks) to satisfy markdownlint MD046; update the
same change at the other occurrence mentioned (around line 435) so all
admonitions use fenced code blocks instead of indented code.

---

Duplicate comments:
In `@docs/enterprise/debian/components/workbench.md`:
- Around line 172-183: The YAML block currently has top-level keys that should
be nested under datastore and the Username key is capitalized; move database,
username (normalize "Username" to lower-case "username" or "user" to match
docs), port, sslmode, and password inside the existing datastore mapping so the
structure becomes datastore: { host: ..., database: ..., username: ..., port:
..., sslmode: ..., password: ... }; ensure key names exactly match the rest of
the docs (use "username" or "user" consistently) and keep host under datastore
as shown.
- Around line 574-578: Remove the incorrect duplicate GRANT for
alert_acknowledgments found under the -- notification_history: Track
notifications section: delete the line "GRANT SELECT, INSERT, UPDATE, DELETE ON
alert_acknowledgments TO dba_alerter;" so only the intended grants for
notification_history (the GRANT on TABLE notification_history and the GRANT on
SEQUENCE notification_history_id_seq) remain.
- Line 453: The sample output contains a real-looking token
"VyGrZzGFUdiZeLZcCTrMR3Nnh2LrqyckpAcmpxlU0=" which should be redacted; locate
that literal token in the workbench sample output and replace it with a generic
placeholder such as <REDACTED_TOKEN> or TOKEN_PLACEHOLDER, and update any
adjacent explanatory text to reflect that the value is an example placeholder
rather than a real token.

In `@docs/enterprise/el/components/workbench.md`:
- Line 457: Replace the hard-coded token-like string
"VyGrZzGFUdiZeLZcCTrMR3Nnh2LrqyckpAcmpxlU0=" in the sample output with a
non-sensitive placeholder (e.g., "<REDACTED_TOKEN>" or "<SAMPLE_TOKEN>") so the
docs no longer expose a reusable-looking secret; update the sample output in
workbench.md where that token appears and ensure any surrounding text still
makes sense with the placeholder.
- Around line 578-582: Remove the incorrect/redundant GRANT for
alert_acknowledgments that appears under the notification_history section:
delete the line "GRANT SELECT, INSERT, UPDATE, DELETE ON alert_acknowledgments
TO dba_alerter;" so only the correct grants for notification_history and
notification_history_id_seq (i.e., "GRANT SELECT, INSERT, UPDATE, DELETE ON
TABLE notification_history TO dba_alerter;" and "GRANT USAGE, SELECT ON SEQUENCE
notification_history_id_seq TO dba_alerter;") remain in that section.
- Around line 182-193: The YAML example has top-level keys that should be nested
under the datastore mapping and uses inconsistent casing; move database,
username, port, sslmode, and password under the existing datastore key, align
their indentation so they are children of datastore, and normalize key names to
lowercase (e.g., username) to match other examples (update the YAML block in
workbench.md where the datastore example appears).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c7bf468d-88fe-4f98-8a10-681966d72dc8

📥 Commits

Reviewing files that changed from the base of the PR and between 38f2413 and f339917.

📒 Files selected for processing (2)
  • docs/enterprise/debian/components/workbench.md
  • docs/enterprise/el/components/workbench.md


!!! hint

You can use `\q` to exit the `psql` client session and return to the

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Address markdownlint MD046 in admonitions.

The indented code-style inside admonitions violates MD046 (expected fenced code blocks).

Also applies to: 431-431

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 76-76: Code block style
Expected: fenced; Actual: indented

(MD046, code-block-style)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/enterprise/debian/components/workbench.md` at line 76, The admonition
uses an indented code-style for the psql example (the line containing `\q` / the
phrase "psql client session") which triggers markdownlint MD046; replace the
indented code block with a fenced code block (``` or ```psql) or convert to
inline code if it’s a single inline token, and make the same change for the
other occurrence that mentions `\q` (the second admonition containing the same
psql/`\q` text).

Source: Linters/SAST tools


!!! hint

You can use `\q` to exit the `psql` client session and return to the

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Address markdownlint MD046 in admonitions.

The indented code-style in admonitions violates MD046; use fenced code blocks there.

Also applies to: 435-435

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 74-74: Code block style
Expected: fenced; Actual: indented

(MD046, code-block-style)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/enterprise/el/components/workbench.md` at line 74, Replace the indented
code-style inside the admonition that contains "You can use `\q` to exit the
`psql` client session and return to the" with a fenced code block (triple
backticks) to satisfy markdownlint MD046; update the same change at the other
occurrence mentioned (around line 435) so all admonitions use fenced code blocks
instead of indented code.

Source: Linters/SAST tools

@susan-pgedge susan-pgedge merged commit 92e89bf into main Jun 10, 2026
4 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