codeant-ai-for-open-source[bot] commented on code in PR #42158:
URL: https://github.com/apache/superset/pull/42158#discussion_r3607541682
##########
docs/admin_docs/configuration/configuring-superset.mdx:
##########
@@ -151,7 +151,7 @@ Superset supports the following database engines/versions:
| 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. |
Review 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]
<details>
<summary><b>Severity Level:</b> Major ⚠️</summary>
```mdx
- ⚠️ Admin configuration docs misdirect readers to nonexistent file.
- ⚠️ Users may miss canonical tested PostgreSQL version source.
- ⚠️ Documentation consistency degraded across installation references.
```
</details>
<details>
<summary><b>Steps of Reproduction ✅ </b></summary>
```mdx
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.
```
</details>
[](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=bad961058297463781322954d4a1b25b&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset)
[](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=bad961058297463781322954d4a1b25b&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset)
*(Use Cmd/Ctrl + Click for best experience)*
<details>
<summary><b>Prompt for AI Agent 🤖 </b></summary>
```mdx
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
```
</details>
<a
href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F42158&comment_hash=14ecbe37e09411cd2b9c985cda20f1149697908c316f536367e25553575cbc9d&reaction=like'>👍</a>
| <a
href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F42158&comment_hash=14ecbe37e09411cd2b9c985cda20f1149697908c316f536367e25553575cbc9d&reaction=dislike'>👎</a>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
