docs: update postgresql supported versions policy#42158
Conversation
Signed-off-by: AMAN UPADHYAY <upadhyayaman512@gmail.com>
dosubot
Bot
added
data:connect:postgres
Code Review Agent Run #23af83Actionable Suggestions - 0Review Details
Bito Usage GuideCommands Type the following command in the pull request comment and save the comment.
Refer to the documentation for additional commands. Configuration This repository uses Documentation & Help AI Code Review powered by |
✅ Deploy Preview for superset-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![codeant-ai-for-open-source[bot]](https://avatars.githubusercontent.com/u/151810221?s=60&v=4){kind=small}
| | Database Engine | Supported Versions | | ||
| | ----------------------------------------- | ---------------------------------------- | | ||
| | [PostgreSQL](https://www.postgresql.org/) | 10.X, 11.X, 12.X, 13.X, 14.X, 15.X, 16.X | | ||
| | [PostgreSQL](https://www.postgresql.org/) | All [currently-supported versions](https://www.postgresql.org/support/versioning/). The highest tested version is defined by the repository's `docker-compose.yaml` and GitHub Actions matrix. | |
There was a problem hiding this comment.
Suggestion: The documentation references docker-compose.yaml, but this repository uses docker-compose.yml; this will send readers to a non-existent file and break the stated source-of-truth guidance. Update the filename extension in this new table row to match the actual file in the repo. [typo]
Severity Level: Major ⚠️
- ⚠️ Admin configuration docs misdirect readers to nonexistent file.
- ⚠️ Users may miss canonical tested PostgreSQL version source.
- ⚠️ Documentation consistency degraded across installation references.Steps of Reproduction ✅
1. Open the documentation file `docs/admin_docs/configuration/configuring-superset.mdx`
and locate the database engines table; at line 154 (per PR hunk) the PostgreSQL row
references the repository's `docker-compose.yaml` as the source of the highest tested
version.
2. Inspect the repository root using the glob search results:
`/workspace/superset/docker-compose.yml` exists (found via
`Glob(pattern="**/docker-compose.*", path="/workspace")`), but there is no
`docker-compose.yaml` file anywhere in the repo.
3. Confirm via search for the string `docker-compose.yaml` (using
`Grep(pattern="docker-compose.yaml", path="/workspace/superset", glob="**/*")`) that this
documentation reference is textual only and does not correspond to an actual file, i.e.,
readers cannot open `docker-compose.yaml` in the repo.
4. A user following the documentation to determine the highest tested PostgreSQL version
will look for `docker-compose.yaml` in the repo root, fail to find it because only
`docker-compose.yml` exists, and therefore be misdirected away from the actual
source-of-truth configuration file.
(Use Cmd/Ctrl + Click for best experience)
Prompt for AI Agent 🤖
This is a comment left during a code review.
**Path:** docs/admin_docs/configuration/configuring-superset.mdx
**Line:** 154:154
**Comment:**
*Typo: The documentation references `docker-compose.yaml`, but this repository uses `docker-compose.yml`; this will send readers to a non-existent file and break the stated source-of-truth guidance. Update the filename extension in this new table row to match the actual file in the repo.
Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.
Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix
|
The flagged issue is correct. The documentation incorrectly references docs/admin_docs/configuration/configuring-superset.mdx |
Signed-off-by: AMAN UPADHYAY <upadhyayaman512@gmail.com>
Code Review Agent Run #531e63Actionable Suggestions - 0Review Details
Bito Usage GuideCommands Type the following command in the pull request comment and save the comment.
Refer to the documentation for additional commands. Configuration This repository uses Documentation & Help AI Code Review powered by |
| | Database Engine | Supported Versions | | ||
| | ----------------------------------------- | ---------------------------------------- | | ||
| | [PostgreSQL](https://www.postgresql.org/) | 10.X, 11.X, 12.X, 13.X, 14.X, 15.X, 16.X | | ||
| | [PostgreSQL](https://www.postgresql.org/) | All [currently-supported versions](https://www.postgresql.org/support/versioning/). The highest tested version is defined by the repository's `docker-compose.yml` and GitHub Actions matrix. | |
There was a problem hiding this comment.
IMHO, this is pretty broad. N-2 should be sufficient instead, akak 16 and 17. We definitely don't want to overstretch the maintainer's effort here.
There was a problem hiding this comment.
Thanks for the review, @hainenber! I totally get the concern about overstretching the maintainers. I only went with this broad phrasing because @sfirke specifically asked for it in #42050 so we wouldn't have to keep updating the docs every release.
@sfirke, do you still prefer the broader approach, or should we lock it down to just N-2? Let me know what you both decide and I'll make the change!
and sorry for replaying soo late.
2 participants
SUMMARY
Per @sfirke's recommendation in issue #42050, this PR updates the PostgreSQL supported versions documentation to prevent the page from going stale as new versions are released.
docker-compose.yamland GitHub Actions matrix as the source of truth for the top-tested version.BEFORE/AFTER SCREENSHOTS || ANIMATED GIF
N/A - Documentation text update only.
TESTING INSTRUCTIONS
Review the modified markdown table in
docs/admin_docs/configuration/configuring-superset.mdxto ensure the text and formatting are correct.ADDITIONAL INFORMATION