markdowneditor

Troubleshooting Guide: Product / system

Symptom/cause/fix index + known issues

Tài liệu & Hỗ trợChuẩntroubleshooting
Mở trong editorTải .md

Cách dùng: Ops/support surfaces. Symptom-first ordering – users search by what they see, not by subsystem.

Xem trước

Troubleshooting Guide: Product / system

Diagnostic first steps

Before anything else:

  1. Check status page / is it just you?
  2. Reproduce: does it happen every time?
  3. Check version: command --version
  4. Check logs: where they live

Issue index

Problem: error message or symptom

  • Cause: most likely reason
  • Check: command or setting to verify
  • Fix: steps to resolve
diagnostic command

Problem: second symptom

  • Cause: reason
  • Fix: steps

Problem: third symptom

  • Cause: reason
  • Fix: steps

Known issues

IssueAffectsWorkaroundTracking
DescriptionvX.YWhat to do meanwhile#NNN

When all else fails

How to get a clean state:

# reset sequence

Reporting a bug

Include: version, OS, steps to reproduce, logs location, expected vs actual. File at: link.

Template liên quan