chore(docs): v2.0.0 doc consolidation, fix stale examples + ship MIGRATION + multi-source sample#38
Merged
fxthiry merged 1 commit intorelease/2.0.0from Apr 16, 2026
Conversation
…ATION + multi-source sample Three v1.x example configs (README Quick Start, docs/getting-started.md minimal, examples/cisco-switches/config.yaml) were rejected by --validate on v2.0.0; they are now migrated to the map shape with a `default:` source. Adds a top-level MIGRATION.md with a 5-section guide for v1.x upgraders: pre-upgrade checklist, config migration with before/after snippets, Prometheus metric migration with PromQL examples, notifier output format changes (Mattermost footer + default webhook payload), and a rollback path. Linked from README and CHANGELOG. Adds examples/multi-source/ with a complete reference config and a README explaining the routing matrix (one rule pinned to prod, one pinned to staging, one fan-out across both). Closes the explicit ask from the issue #34 reporter for a sample multi-source config. README Features list hoists "One Valerter for every VictoriaLogs you run" to position #1, reworded outcome-led. A blockquote callout right after Quick Start points v1.x upgraders at MIGRATION.md. docs/performance.md gains an accuracy banner since the throughput numbers were measured against v1.x (single task per rule); the multi-source N x M task model and max_streams cap are mentioned and will be re-measured separately. Two new integration tests in tests/integration_validate.rs lock the shipped samples against future drift: shipped_config_example_validates and shipped_examples_pass_validate (iterates examples/*/config.yaml). The 2.0.0 entry in CHANGELOG gains one Added line pointing at the new sample and MIGRATION.md.
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.
Closes the documentation gaps that were not addressed during the multi-source feature work, before tagging v2.0.0 final.
What ships
README.mdQuick Start,docs/getting-started.mdminimal,examples/cisco-switches/config.yaml) migrated to the v2.0.0 map shape with adefault:source. They would otherwise have been rejected by--validateafter a copy-paste.MIGRATION.mdat repo root: 5-section guide for v1.x upgraders covering the pre-upgrade checklist, config before/after, Prometheus metric migration with PromQL examples, notifier output format changes (Mattermost footer + default webhook payload), and a rollback path. Linked fromREADME.mdandCHANGELOG.md.examples/multi-source/: complete reference config (2 sources, 3 rules covering pinned single-source + fan-out) plus aREADME.mdexplaining the routing matrix. Closes the explicit ask from the issue #34 reporter.docs/performance.mdaccuracy banner: throughput numbers in that page were measured against v1.x (single task per rule); the v2.0.0 N×M task model andmax_streamscap are now mentioned at the top with a note that re-measurement is pending.shipped_config_example_validatesruns--validateonconfig/config.example.yaml.shipped_examples_pass_validateiteratesexamples/*/config.yamland runs--validateon each.Validation
cargo test— 551 tests pass (479 lib + 72 integration, +2 new inintegration_validate)cargo clippy --all-targets --all-features -- -D warnings— cleancargo fmt --check— cleanvalerter --validate -c <path>→ exit 0--validate→ exit 0Out of scope (deferred to follow-up)
.mdfilesvictorialogs.urlshape is detected (code change, separate concern)