docs: close real UX gaps found reading every doc as a first-time user - #30
Merged
Conversation
Closes #29 No doc showed how to get a NetBird token or create the Secret the Helm examples reference. Added both, a generic-sink example, and made troubleshooting actionable with real log lines.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
A close, first-time-user read of every doc found real gaps: instructions that told a reader what to do but not how, exactly where precision actually matters, and a troubleshooting table too generic to act on.
Closes #29
Key Changes
envFromSecret.NETBIRD_API_TOKEN=netbird-audit/audit-tokenas if that Secret already existed. None showed thekubectl create secretcommand to actually create it, a real user following any of the three literally would hit "secret not found" with no path forward. Added it to all threedocs/SINKS.mdhad an abstract variable table but no worked example. Added a fulldocker runexample wiring up a generic HTTP webhook sink end to endFailed to fetch events from Netbird: ... 401means a bad token, a connection error means the URL/network, etc.)docker runwith no-dthat ran in the foreground and no-p 9090:9090, so the "confirm it's running" curl command I'd added couldn't actually work as written; and aRUST_LOG=debugclaim that overstated what it does (there's nodebug!/trace!logging anywhere in the code, verified by grep, so it only adds HTTP-client-level noise, not application detail)Verification
Every log message and metric name quoted in the new troubleshooting table is copy-checked against the actual source (
grep -n "error!\|Failed to" src/main.rs,grep -n "auditbridge_" src/metrics.rs), not written from memory.cargo test(28 passed),cargo clippy --all-targets -- -D warnings(clean),cargo fmt --check(clean),helm lint charts/auditbridge(clean).Out of Scope
No version tag or release in this PR, docs-only per this round of review.