Skip to content

docs(troubleshooting): add support diagnostics page - #336

Open
pau-hedgehog wants to merge 2 commits into
masterfrom
pau/support-bundle-docs
Open

pau-hedgehog wants to merge 2 commits into
masterfrom
pau/support-bundle-docs

Conversation

@pau-hedgehog

@pau-hedgehog pau-hedgehog commented Jul 29, 2026 •

Copy link
Copy Markdown
Contributor

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-level show techsupport captures may be requested, and a note that these artifacts should be treated as confidential.

@pau-hedgehog
pau-hedgehog requested a review from a team as a code owner July 29, 2026 21:06
@github-actions

Copy link
Copy Markdown

🚀 Deployed on https://preview-336--hedgehog-docs.netlify.app

@pau-hedgehog
pau-hedgehog marked this pull request as draft July 29, 2026 21:08
@pau-hedgehog pau-hedgehog self-assigned this Jul 29, 2026
@edipascale
edipascale requested a review from Copilot July 30, 2026 06:16

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread docs/troubleshooting/contacting_support.md Outdated
@pau-hedgehog
pau-hedgehog force-pushed the pau/support-bundle-docs branch 3 times, most recently from d572f7f to 3b2bbfc Compare July 30, 2026 11:22
@pau-hedgehog pau-hedgehog changed the title docs(troubleshooting): add contacting support page docs(troubleshooting): add support diagnostics page Jul 30, 2026
@pau-hedgehog
pau-hedgehog force-pushed the pau/support-bundle-docs branch 2 times, most recently from 9540e59 to 8a558e4 Compare July 30, 2026 12:49
@pau-hedgehog
pau-hedgehog marked this pull request as ready for review July 30, 2026 12:49
Comment thread docs/troubleshooting/support_diagnostics.md
@Frostman
Frostman marked this pull request as draft August 18, 2026 04:28
@pau-hedgehog
pau-hedgehog marked this pull request as ready for review September 26, 2026 09:47
@pau-hedgehog
pau-hedgehog force-pushed the pau/support-bundle-docs branch from 4f1fcda to 664de33 Compare September 26, 2026 09:48
@pau-hedgehog
pau-hedgehog requested review from edipascale and a lite review from Copilot September 26, 2026 09:48
@pau-hedgehog

Copy link
Copy Markdown
Contributor Author

Updating this one with learnings from #353

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

Only a minor executable-name documentation nit remains, with no approval-blocking issues.

Review effort: Lite
Findings: None

Resolved since last review (1)

pau-hedgehog and others added 2 commits September 30, 2026 16:01
Signed-off-by: Pau Capdevila <pau@githedgehog.com>
Adds a section on collecting /var/log/agent.log for BGP/BFD/interface
issues that won't stabilize, learned from a real triage where the
support bundle's Agent CR status looked converged the whole time
despite active flapping (#353).

Also rewords the raw-output bullet per review: encourage raw output
plus the reporter's own summary, not raw output instead of one.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Signed-off-by: Pau Capdevila <pau@githedgehog.com>
@pau-hedgehog
pau-hedgehog force-pushed the pau/support-bundle-docs branch from 664de33 to 1993ad8 Compare September 30, 2026 14:02

This branch has not been deployed

No deployments
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.

3 participants