Repository navigation
docs(engine): correct claims and redraw diagrams - #1187
Merged
Merged
Conversation
Update claims across every page under docs/, the README and CONTRIBUTING against the code and sibling repos. Pages covered by #1177 are unchanged. The engine applies ClickHouse DDL itself and commits no ddl/ or envoy/ tree. The fork's create-rule button posts to its route. It sends no postMessage to dfe-ui. scalo rejects MSK IAM. `main` is a core source the API will not modify. `If-Match` is optional on a write. Redraw all 58 Mermaid diagrams to the diagram standard. Replace text diagrams with Mermaid or lists where no picture is needed. All 62 diagrams pass the checker on Mermaid 12.3.0. architecture.md holds L2 Services -- DFE and L3 Components -- dfe-engine. Cut config comments in 17 files to pointers and short reasons. Move the retained explanations to the docs. No value changes.
Restore "Buffering without a bus" in transports.md. The deployment README links to it. dfe-infra's mesh receiver profile still configures it.
dfe-transform-vector scales on ScalingPressure on the single, scale and mesh profiles, as the archiver and the other transforms do.
The charts poll the shim at /keda/pressure. That path is an alias for the pressure query on the generic /q/{name} route.
The view execution sequence shows the API fetching the view through the executor. ClickHouse answers the executor rather than the API.
# Conflicts: # CONTRIBUTING.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.
Correct claims against the code and sibling repos across docs/, the README and CONTRIBUTING. Leave the three pages covered by #1177 untouched.
docs claims: 5598 claims with 428 FAIL before, 5958 with 466 FAIL after. Each FAIL left has a reason for rejection. The generated route map accounts for 193.scripts/generate_openapi.pyregenerates with no diff. The spec stays at VERSION.Corrected docs:
ddl/orenvoy/tree.msk_iam, which two pages offered.mainis a core source the API will not modify.If-Matchis optional on a write.Restore the README's sampling bullet dropped by #1152. Keep the other PRs' cuts to text about things never built.
Diagrams: 58 failing Mermaid diagrams and seven text diagrams before, 62 diagrams after.
62 diagram(s), 0 failing, 0 page finding(s) (rendered with Mermaid 12.3.0).Config comments: 431 lines out, 76 in. No value changed. Files:
appmgmt/apps.yamlkeeps its comments because it copies dfe-infra's file.838 unit tests that read the touched configs pass.
hyperi-ci lint-docsis clean. lychee is not installed.docs slopis clean.Overlapping open PRs: #1184, #952, #950, #949, #948, #947, #946.