Repository navigation
docs(docker): fix claims and redraw diagrams - #407
Merged
Merged
Conversation
Correct claims in README.md and docs/. The PR has the ledger counts. - architecture.md corrects claims that transforms push to the loader on gRPC and that the fetcher and transforms dial port 6000. No profile runs either on gRPC. Only the receiver dials port 6000. - The troubleshooting diagram checks the subscription, matching the text. The DLQ paragraphs move from the one-shot heading to the DLQ. - CONTRIBUTING.md corrects its claim that CI starts no stack. The image and published-compose jobs start one and count each demo source's rows. - auth-profile.md opens with its status: off by default, wiring checked, no e2e sign-in. - Fix two link labels pointing to the wrong page. Restore the readiness heading in observability.md. - Restore the stack manifest and signer variables dropped from README to configuration.md. Add the make help pointer to developing.md. Add the not-a-HEALTHCHECK note to self-test.md. All ten diagrams are redrawn to the diagrams standard and pass diagram_check on Mermaid 12.3.0. Split the 1392 px wide troubleshooting diagram into two. developing.md was 4,439 words. Move the test suites to testing.md and checks.md. Move live console mode to live-console.md. Replace copies of operating.md and known-issues.md content with links. Config comments are cut to pointers and short reasons in the Makefile, ci.yml, docker-compose.yml, service_profiles.yaml, ruff.toml, droast.toml and .gitignore. Each file parses to the same data as before. The footprint key defaults move to profiles.md. Signed-off-by: Derek <derek@hyperi.io>
- The kill tests cover the VRL transform on Kafka, not on direct gRPC. - The e2e suite runs no collector unless a test sets `otel: true`. - `make proof` falls back from the pinned tag to the default branch. - The source test reads the admin login from `env/engine.env`. - ruff, pytest, uv and Envoy need a network on a first check. - A live-mode apply prunes deleted sources and updates the collector. - The diagram descriptions name the `dfe.otel_*` tables and the targets that read profile.mk. Cut or replace uses of 'refuses', 'requires', 'carries', 'already', 'also', 'too', 'gains' and 'prove'. The ledger lists the uses kept. Split the semicolons in four config comments. Shorten three comment blocks in ci.yml. The data each config file holds is unchanged. Signed-off-by: Derek <derek@hyperi.io>
The e2e suite puts the stack it found back on a pass, a failure or a SIGTERM. A SIGKILL or a host failure skips that, so testing.md says to start the stack again by hand. Signed-off-by: Derek <derek@hyperi.io>
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.
Fix incorrect claims in README.md and docs/. Redraw the diagrams. Shorten config comments to pointers.
Claim totals for README.md and docs/: 2461 claims, 916 PASS, 24 FAIL fixed, 1521 UNCHECKABLE. No FAILs are open. Main corrections:
Restore:
DFE_STACK_MANIFEST_REPOand twoDFE_STACK_SIGNER_*keys from docs(readme): introduce the repo in the README #380.make helppointer from docs(readme): introduce the repo in the README #380.Diagrams: 9 failing diagram_check before, 10 passing on Mermaid 12.3.0 after. Screenshot checks cover light and dark.
developing.md was 4,439 words. Move its test suites to testing.md and checks.md. Move live console mode to live-console.md.
Config comment lines, before and after:
Each file loads to the same data.
make -pnq helpprints the same database.make check: 2412 tests passed. ruff is clean. check-docs passed over 21 documents.Prose check flags heading density in README.md and common-failures.md. Their headings mark sections. CONTRIBUTING.md has prose-check hits in the template and DCO text.