Repository navigation
docs(docs): redraw the as-built views at v0.2.0 - #170
Merged
Merged
Conversation
Brings docs/diagrams/as-built.md from ea0f9b5 (16 Oct) to v0.2.0: the console, plan limits with Redis, held-reservation recovery, the access plans and console tables, the accounting adjustments table, and the cfg-D cloud configuration. Adds a domain derivation with aggregates, class diagrams for two use cases (billing one streamed call, admitting one call), the Redis key layout and the delivery pipeline. Refs #78
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.
Summary
docs/diagrams/as-built.mdwas last drawn atea0f9b5(16 October). It did not show the console, plan limits with Redis (#157), held-reservation recovery (#154, #155), theplans,console_usersandwallet_adjustmentstables, or the cloud configuration used on 18 and 19 October. This PR redraws the page from the code atv0.2.0(1d259c1).It is a docs-only change: no code, chart, workflow or rule file changes. Sections:
metering recoverjob.access(8 tables) andaccounting(4 tables); the Redis key layout; concurrency notes.These diagrams are also the source for the final report's architecture figures.
Linked issues
Closes #78
Delivery
complete
Acceptance phase
pre-merge. The owner reviewed the content, through a section-by-section Chinese translation, before this PR was opened.
Verification
mermaid.render9034e85/mainat1d259c1, up to date, no uncommitted inputsas-built.mdpython -m unittest discover -s tools/repo/tests1d259c1; each section lists the files it was checked againstCI on this PR is the remaining check.
Risk and recovery
Docs only. Recovery: revert the PR. The anchor
#4-physical-view-cloud, linked fromdocs/diagrams/index.html, is unchanged; the deviations section moved from 7 to 9, and nothing in the repository links its old anchor.Known limitations
docs/diagrams/index.htmlstill describes the 12 October plan, with 5b updated to 17 October (it says, for example, that the chart has no Redis). It is labelled as that snapshot and is not changed here.evidence-day2andevidence-day3), not from a values file in the repository.Posted by an agent.