Repository navigation
docs(console): correct docs and redraw all ten Mermaid diagrams - #743
Merged
Merged
Conversation
Corrections cover every page under docs/, the README and CONTRIBUTING. They reflect the code, dfe-engine, dfe-hyperdx, dfe-infra and hyperi-ci. - Correct the documented LOG_LEVEL range from DEBUG to ERROR to TRACE to CRITICAL. - build-and-deploy.md explains the chart destination and `make build`. It says an empty NEXT_PUBLIC_API_URL sends the browser to the console's origin for the engine. - authentication.md says renewal sets the dfe_token cookie again. - The Flow card docs cover a source fed by a pipeline. - Redraw all ten Mermaid diagrams to the diagram standard. The L3 console diagram goes at the top of architecture.md. The rest are L4. Three become sequence diagrams and one a state diagram. - Cut config comments to pointers and short reasons. - Move the yarn age gate's CVE exception to CONTRIBUTING. - Remove the Dockerfile comment describing a cache order the file does not have. Signed-off-by: Derek <derek@hyperi.io>
The 'engine URL is not configured' message shows when INTERNAL_API_URL and NEXT_PUBLIC_API_URL are both unset. The server code reads either one. The image has NEXT_PUBLIC_API_URL baked empty. INTERNAL_API_URL decides whether the message shows in the image. Signed-off-by: Derek <derek@hyperi.io>
# Conflicts: # CONTRIBUTING.md # docs/local-development.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.
docs/, the README and CONTRIBUTING match this repo's code and dfe-engine, dfe-hyperdx, dfe-infra and hyperi-ci.
Fix 17 FAIL claims out of 547 claims. Claim status: 265 PASS, 228 UNCHECKABLE and 37 false FAILs. Most UNCHECKABLE claims are backticked names the tool cannot locate. The false FAILs concern sibling-repo paths, paths relative to a directory, the image name and a yarn setting.
LOG_LEVELruns TRACE to CRITICAL, not DEBUG to ERROR.uploadedSchemaColumns. Submit is blocked if any row is invalid./lag, not/flow.make builddoes. An emptyNEXT_PUBLIC_API_URLsends the browser to the console's origin.dfe_tokencookie again.Restore:
Replace the 10 diagrams rejected by the checker. All 10 pass the diagram checker on Mermaid 12.3.0 and hyperi-ci's mermaid-parse. architecture.md opens with an L3 diagram of the console. The rest are L4.
Convert Three diagrams to sequence diagrams. Convert one to a state diagram.
Trim config comments without changing values: