Repository navigation
docs(vector): restore diagrams and correct docs - #172
Merged
Merged
Conversation
Restore the README pod diagram as the repo's top L3 view, drawn to the house standard. Replace the architecture page's mixed-level diagram with an L4 of config assembly. Add an L4 of the direct transport bridge. Add a wrapper to the lifecycle state diagram in internals.md. All four pass the checker on Mermaid 12.3.0. Restore internals.md details: - The Vector counter behind each record metric. - What a failed scrape does. - The 4 MiB scrape cap. It names the two flat env vars that set TLS and the SASL mechanism on both endpoints. It lists the kafka and grpc transport aliases and the chart preview command. Readiness docs match the scrape code: the sink stalls on held or refused records. TESTING.md says the filebeat case fails under CI without its sibling checkout. Config comments are cut to pointers and short reasons in .hyperi-ci.yaml, Cargo.toml, deny.toml, clippy.toml, .cargo/config.toml, .gitignore and the Makefile. No value changes.
# Conflicts: # CONTRIBUTING.md
Figure 1 in the README drew the bridge as one box feeding Vector, but the bridge takes Vector's output back. The diagram has two bridge boxes: intake into Vector and return from Vector, matching the two listeners in src/bridge.rs. The diagram passes the checker at 864x593 on Mermaid 12.3.0. Correct librdkafka.md's claim that config-check rejects enable.auto.offset.store: true from any layer. The check in src/config/loader.rs reads the source consumer's layers alone.
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.
Correct docs in the README, docs pages, CONTRIBUTING, TESTING and filebeat README.
The ledger has 921 rows: 471 PASS, 10 FAIL and 440 UNCHECKABLE. Fix the 10 FAILs.
hyperi-ai docs claimsstill reports 55 FAILs. Each names something defined in scalo, dfe-infra, dfe-transform-vrl, librdkafka or Vector.Restore:
hyperi-ci chart assemblepreview command.The 2 diagrams failed the checker. All 4 replacement diagrams pass on Mermaid 12.3.0.
The architecture diagram was 2129 px wide with 5 skip arrows and two levels in one picture. Replace it with separate L4 diagrams for config assembly and the direct transport bridge.
The lifecycle state diagram has its wrapper and uses landscape layout.
Fix five further doc errors:
enable.auto.offset.store: trueis rejected.Trim config comments in .hyperi-ci.yaml, Cargo.toml, deny.toml, clippy.toml, .cargo/config.toml, .gitignore and the Makefile, with every value unchanged.