docs(app): add dedicated Troubleshooting page#3696
Conversation
|
From the current draft, I already know that @Frzk does not like the "Quick Resolution Guide" in the "Getting Started" section. Since "Common deployment errors" have been moved to the dedicated "Troubleshooting" section, I chose to keep a page in "Getting Started" to help customers understand the stack and identify common sources of issues. If we decide not to keep this "Quick Resolution Guide", we can still remove it from that section. |
|
The PR is ready for review or still in draft? |
Ready for review 👌 Thanks |
|
@benjaminach: I've just pushed the new Jekyll tag in this branch, so you may want to wait until I can put it on all concerned pages? |
Legal RiskThe following dependencies were released under a license that RecommendationWhile 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
|
Frzk
left a comment
There was a problem hiding this comment.
- I feel like the new Troubleshooting pages are great, but maybe lack a bit of polish/homogeneity pass. This can come later.
- Not found of the "Quick Resolution" page (more below)
- A very little nitpicky, non-blocking suggestion.
In this pass I tried to limit changes to the structuration of the pages, but indeed, we will have to rework the content a bit further. |
EtienneM
left a comment
There was a problem hiding this comment.
praise: I love the timeline 🤩
praise: thanks a lot for this refacto
I just added a bunch of suggestions, but already approving.
2e7198a to
2fd50d5
Compare
2fd50d5 to
1fb79b4
Compare
This PR reorganizes the troubleshooting documentation to make first deployment
issues easier to identify and route to the right detailed page.
Main changes:
platform/app/troubleshootingsection.pages:
failures.
troubleshooting section.
and container management pages.
Why
The previous structure mixed several troubleshooting phases in pages that were
hard to scan and not always clearly named. This change separates deployment,
startup, and runtime issues so users can first identify where the failure
happens, then follow the relevant detailed guide.
Notes
common-deployment-errorspage is intentionally removed.the end of the
301section.This PR continues the work initiated by @sc-zenokerr in #3485.