Skip to content

docs: remove database: ${POSTGRES_DB} env#201

Merged
rm3l merged 1 commit intoredhat-developer:mainfrom
Fortune-Ndlovu:schema-update
Apr 28, 2026
Merged

docs: remove database: ${POSTGRES_DB} env#201
rm3l merged 1 commit intoredhat-developer:mainfrom
Fortune-Ndlovu:schema-update

Conversation

@Fortune-Ndlovu
Copy link
Copy Markdown
Member

Description

chore(doc): remove database: ${POSTGRES_DB} env
during testing this was actually not needed

Which issue(s) does this PR fix or relate to

  • Fixes #issue_number

PR acceptance criteria

  • Tests updated and passing
  • Documentation updated
  • Built-in TechDocs updated if needed. Note that TechDocs changes may need to be reviewed by a Product Manager and/or Architect to ensure content accuracy, clarity, and alignment with user needs.

How to test changes / Special notes to the reviewer

Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
@rhdh-qodo-merge
Copy link
Copy Markdown
Contributor

rhdh-qodo-merge Bot commented Apr 28, 2026

Code Review by Qodo

🐞 Bugs (2) 📘 Rule violations (0)

Grey Divider


Remediation recommended

1. Stale POSTGRES_DB variable 🐞 Bug ⚙ Maintainability
Description
The PostgreSQL guide removes the use of ${POSTGRES_DB}, but the repo still ships POSTGRES_DB in
default.env, leaving the documentation and default environment template inconsistent and potentially
confusing for users configuring Postgres.
Code

docs/rhdh-local-guide/postgresql-guide.md[83]

-         database: ${POSTGRES_DB}
Relevance

⭐⭐⭐ High

Team often aligns docs with default.env to avoid confusion (e.g., env var docs sync in PR #149;
default.env alignment PR #57).

PR-#149
PR-#57

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
The guide’s Postgres connection snippets now only include host/port/user/password and no longer
include a database name placeholder, but default.env still defines POSTGRES_DB, implying users may
need or can configure it even though the guide no longer mentions it.

docs/rhdh-local-guide/postgresql-guide.md[61-83]
default.env[1-6]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The Postgres guide no longer references `${POSTGRES_DB}`, but `default.env` still defines `POSTGRES_DB`, creating an inconsistency for users following the documented setup.

### Issue Context
Either the variable is truly unnecessary and should be removed from the default environment template, or it should be documented as optional/when needed (e.g., when using a non-default database).

### Fix Focus Areas
- default.env[1-6]
- docs/rhdh-local-guide/postgresql-guide.md[61-83]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Advisory comments

2. Missing newline at EOF 🐞 Bug ⚙ Maintainability
Description
docs/rhdh-local-guide/postgresql-guide.md is missing a trailing newline, which causes noisy diffs
and can trigger formatting/lint issues in some tooling.
Code

docs/rhdh-local-guide/postgresql-guide.md[83]

</details>
Relevance

⭐⭐ Medium

No clear historical review pattern found about enforcing trailing newline/EOF formatting in docs
files.

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
The PR diff explicitly marks the file as lacking a newline at end-of-file after this edit.
Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The markdown file ends without a trailing newline.

### Issue Context
Git marks this as `\ No newline at end of file`; adding a final newline avoids future diff noise and tooling warnings.

### Fix Focus Areas
- docs/rhdh-local-guide/postgresql-guide.md[83-83]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

@sonarqubecloud
Copy link
Copy Markdown

@rhdh-qodo-merge
Copy link
Copy Markdown
Contributor

Review Summary by Qodo

Remove unnecessary POSTGRES_DB environment variable from docs

📝 Documentation

Grey Divider

Walkthroughs

Description
• Remove unnecessary database: ${POSTGRES_DB} environment variable from PostgreSQL configuration
  example
• Simplifies documentation by eliminating unused configuration parameter
Diagram
flowchart LR
  A["PostgreSQL Guide Documentation"] -- "Remove unused database env var" --> B["Simplified Configuration Example"]
Loading

Grey Divider

File Changes

1. docs/rhdh-local-guide/postgresql-guide.md 📝 Documentation +0/-1

Remove unused POSTGRES_DB environment variable

• Removed database: ${POSTGRES_DB} line from PostgreSQL configuration example
• Simplifies the configuration snippet by eliminating an unused environment variable
• Configuration now only includes essential parameters: port, user, and password

docs/rhdh-local-guide/postgresql-guide.md


Grey Divider

Qodo Logo

@rhdh-qodo-merge rhdh-qodo-merge Bot added the documentation Improvements or additions to documentation label Apr 28, 2026
@rm3l rm3l changed the title chore(doc): remove database: ${POSTGRES_DB} env docs: remove database: ${POSTGRES_DB} env Apr 28, 2026
@rm3l rm3l merged commit e13df75 into redhat-developer:main Apr 28, 2026
43 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants