feat: add more troubleshooting examples#2243
feat: add more troubleshooting examples#2243Patrick Derks (TrayserCassa) wants to merge 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds additional Shopware PaaS Native troubleshooting guidance and a small clarification for database CLI access, expanding the docs set with more actionable workflows for common operational issues.
Changes:
- Add a new “Troubleshooting common issues” guide with CLI/Grafana-based workflows and data to collect for support.
- Clarify which password to use when opening a MySQL tunnel via
sw-paas open service.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| products/paas/shopware/resources/databases.md | Adds a brief note about the password used when connecting to MySQL via CLI tunnel. |
| products/paas/shopware/guides/troubleshooting.md | New troubleshooting guide covering response timing headers, Grafana logs/traces, deployment not live, and stuck workers. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| sw-paas open service --service database --port 3306 | ||
| ``` | ||
|
|
||
| Use the Shopware admin password when the MySQL client prompts for the database password. |
There was a problem hiding this comment.
This instruction is ambiguous: “Shopware admin password” usually refers to the Shopware Administration UI user, not MySQL credentials. Please clarify which credential the MySQL client expects here and how to retrieve it (e.g., which sw-paas command outputs it or which secret/variable contains it).
| Use the Shopware admin password when the MySQL client prompts for the database password. | |
| When the MySQL client prompts for a password, use the password for the database user of the managed MySQL service. Do not use the Shopware Administration UI password. |
| position: 90 | ||
| --- | ||
|
|
||
| # Troubleshooting common issues |
There was a problem hiding this comment.
The page H1 uses sentence case (“Troubleshooting common issues”) while other Shopware docs pages consistently use Title Case headings (e.g., “# Manage Cron Jobs” in products/paas/shopware/guides/cronjobs.md). Consider aligning the H1 capitalization with the nav title and the existing convention for page titles.
| # Troubleshooting common issues | |
| # Troubleshooting Common Issues |
| ```sh | ||
| sw-paas application get --application-id <application-id> | ||
| ``` |
There was a problem hiding this comment.
sw-paas application get isn’t referenced elsewhere in these docs (the Applications guide documents create, list, update, build logs, and deploy ...). If this command doesn’t exist (or uses a different name/flags), readers will get stuck here—please confirm it’s correct or switch to a documented command (and/or link to the CLI reference section that describes it).
Summary
Related links
Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted..wordlist.txt(and sorted it) if spellcheck flags new legitimate terms.Notes