docs(troubleshooting): add support diagnostics page - #336
Conversation
|
🚀 Deployed on https://preview-336--hedgehog-docs.netlify.app |
There was a problem hiding this comment.
Pull request overview
Adds a new Troubleshooting subpage that guides users on what information to provide when contacting support, including how to collect a support bundle and when switch-level diagnostics may be needed.
Changes:
- Added a new “Contacting Support” troubleshooting page with recommended details to include, support bundle collection steps, and confidentiality guidance.
- Updated troubleshooting navigation to include the new page.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/troubleshooting/contacting_support.md | New documentation page describing what to gather and share when engaging support (bundle collection, switch dumps, confidentiality). |
| docs/troubleshooting/.pages | Adds the new page to the troubleshooting section navigation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Any diagnostics you've already collected yourself. Include the raw output | ||
| rather than a summary - it saves a round trip re-deriving what you already | ||
| found. |
d572f7f to
3b2bbfc
Compare
pau-hedgehog
changed the title
3b2bbfc to
9540e59
Compare
Signed-off-by: Pau Capdevila <pau@githedgehog.com>
9540e59 to
8a558e4
Compare
| or node/server move - even if you're not sure it's related. | ||
| - Which specific switches or nodes are affected, if you've already narrowed | ||
| it down. | ||
| - Any diagnostics you've already collected yourself. Include the raw output |
There was a problem hiding this comment.
isn't that contradictory? if they provide us with the raw output and not the output, that means we need to re-derive what they have already found. I'd say we still want the raw output, but motivate it differently - e.g. we want to be able to reach our own conclusions / exclude other possible root causes etc. I'd still encourage them to give us any summary (in addition to the raw output) if they did any troubleshooting themselves.
Adds a "Contacting Support" page to the troubleshooting section: what to include when reaching out (version/topology, symptom + timing, affected nodes, existing diagnostics), how to collect a support bundle (
hhfabctl support dump -y), when switch-levelshow techsupportcaptures may be requested, and a note that these artifacts should be treated as confidential.