docs: real end-to-end proof, GitHub alert blocks, release-ready wording - #28
Merged
Conversation
Adds examples/local-demo (real Loki, real syslog receiver, stubbed NetBird) and real screenshots from running it, replacing an orphaned image. Adds GitHub alert blocks. Rewrites SECURITY.md and Helm docs to drop before/after-first-release wording that goes stale on tag.
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
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
Closes the gaps found in a full review of
mainbefore the first release: no GitHub alert blocks anywhere, no screenshots proving anything works (the docs restructure in #25 orphaned the one safe image without replacing it), andSECURITY.md/the Helm install docs used "before/after the first release" wording that goes stale the moment a release ships.Relates to #22
Relates to #24
Key Changes
examples/local-demo/: a real, runnabledocker compose up(real Loki, a real syslog receiver, a disclosed NetBird API stub since no live account is available) that reproduces the exact setup the new screenshots showdocs/images/live-*.png) captured from actually running that demo: startup and delivery logs, a real Loki query returning the delivered events, and live/healthz/readyz/metricsoutput. Removed the orphaned, unreferencedgrafana_dashboard_example.png[!WARNING],[!NOTE],[!TIP]) in README and docs, each on a genuinely load-bearing fact (don't uselatestin production,CURSOR_FILEneeds durable storage, use_HEADERS_FILEfor sink credentials), not decorativeSECURITY.mdand the Helm section ofdocs/INSTALLATION.mdrewritten to describe a stable ongoing policy instead of a transitional pre-release stateVerification
Ran the exact committed
examples/local-demoend to end (not just the scratch version used to draft it):Also confirmed via a direct Loki query that the delivered log bodies include
initiator_email(the label-drift fix from #11 still holds), and via the syslog receiver's own log that RFC3164-framed events actually land over the wire, not just that the code compiles.cargo test(28 passed),cargo clippy --all-targets -- -D warnings(clean),cargo fmt --check(clean),helm lint charts/auditbridge(clean) all still pass.Out of Scope
Git history still contains the credential-exposed image blob from before #26; this was a deliberate decision (token already revoked, rewriting history not worth invalidating every existing clone/fork for an already-dead credential), not an oversight.