docs(weathertop): improve operator setup and troubleshooting guide#7749
docs(weathertop): improve operator setup and troubleshooting guide#7749mjfxjas wants to merge 2 commits intoawsdocs:mainfrom
Conversation
|
Thanks again for the review and approval. If there is anything else you want adjusted before merge, wording, structure, or troubleshooting detail, I can update quickly. |
|
Good question. The point is to reduce setup-to-first-success time for operators who hit common failures. This addition gives a quick triage path for the issues we see most often (credentials/config/runtime mismatch), so users can isolate root cause fast instead of stepping through the full guide. If this still feels too broad for this PR, I can trim it to only the highest-frequency troubleshooting case and move the rest to a follow-up docs change. |
|
Thanks for the pushback here. I made a focused update to clarify the direct operator benefit in the doc itself and kept scope narrow:\n\n- added a concise "Why this section exists" note to explain the intent\n- explicitly tied the checklist to reducing setup-to-first-success time\n- kept the content centered on common first-run failure points\n\nIf you want this reduced further, I can trim it to only the top 1-2 failure cases. |
|
This update is for an outdated (internal) tool, I'm going to close both the outdated issue and this PR. |
Summary
Improves Weathertop tool documentation with a practical setup and operations guide.
Changes
Why
Issue #6961 requested improved documentation to make the tool easier for teams to understand and operate.
Closes #6961