Skip to content

feat(docs): add troubleshooting guide for common application issues#3485

Open
sc-zenokerr wants to merge 5 commits intomasterfrom
fix/3100/troubleshooting-page
Open

feat(docs): add troubleshooting guide for common application issues#3485
sc-zenokerr wants to merge 5 commits intomasterfrom
fix/3100/troubleshooting-page

Conversation

@sc-zenokerr
Copy link
Copy Markdown
Contributor

@sc-zenokerr sc-zenokerr commented Dec 31, 2025

Fixes #3100

This PR adds a dedicated "Troubleshooting your application" page that helps the users find common errors by linking them to the relevant documentation pages.

I am not too happy with the page ordering in the menu of the Platform/App section. I think we should address it in another PR

image

@sc-zenokerr sc-zenokerr requested a review from Frzk December 31, 2025 10:08
@sc-zenokerr sc-zenokerr self-assigned this Dec 31, 2025
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm a bit puzzled with this PR because we already have this page: https://doc.scalingo.com/platform/app/crash and they seem to overlap a lot.

Maybe we should rather edit the existing one with missing information (if any)?
Maybe we should rename the existing one for it to be more discoverable?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think this new page is quite useful. It is common troubleshooting with links to other appropriate places. The motivation for the PR is provided in the issue, which is to help our customers find the information and reduce the load on support. @mickael-plassard @CalianasJ WDYT?

@sc-zenokerr sc-zenokerr requested a review from Frzk January 30, 2026 13:20
Copy link
Copy Markdown
Contributor

@aurelien-reeves-scalingo aurelien-reeves-scalingo left a comment

Choose a reason for hiding this comment

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

I pretty agree with @Frzk

Would it be possible to kind-of merge those two pages? Rework the existing one instead of adding a new one that has the same purpose? And eventually rename the "App crash" one into "Troubleshooting" for it to be easier to be found?

@sc-zenokerr
Copy link
Copy Markdown
Contributor Author

OK. I'll see if I can merge the two. Thanks for the feedback

@semgrep-code-scalingo
Copy link
Copy Markdown

Legal Risk

The following dependencies were released under a license that
has been flagged by your organization for consideration.

Recommendation

While merging is not directly blocked, it's best to pause and consider what it means to use this license before continuing. If you are unsure, reach out to your security team or Semgrep admin to address this issue.

MPL-2.0

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.

Fixing Timeout Errors is hard to find

4 participants