[docs] docs: simplify Cluster Stability Check section in architecture.mdx#4648
Open
github-actions[bot] wants to merge 1 commit intomainfrom
Open
[docs] docs: simplify Cluster Stability Check section in architecture.mdx#4648github-actions[bot] wants to merge 1 commit intomainfrom
github-actions[bot] wants to merge 1 commit intomainfrom
Conversation
Remove implementation-level details (specific threshold counts, timeouts, busybox pod internals) from the end-user architecture page. These details belong in CONTRIBUTING.md. The key concepts (two-phase installation, stability check before GitOps) are preserved at a level useful to advanced users. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
14 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
This PR simplifies the “Cluster Stability Check” portion of the Architecture documentation to keep the page user-focused and avoid implementation-level specifics.
Changes:
- Condenses the “Cluster Stability Check” description by removing specific thresholds/timeouts and internal mechanics.
- Simplifies the “Detection and Updates” paragraph to a higher-level explanation of how installed components are identified.
| ### Detection and Updates | ||
|
|
||
| The detector service identifies installed components by querying Helm release history and the Kubernetes API, with additional checks against the Docker daemon where needed. It determines the active distribution, provider, and cluster name from the current kubeconfig context, and distinguishes KSail-managed GitOps resources from unrelated ones so it does not interfere with external GitOps setups. | ||
| KSail detects installed components by querying Helm release history and the Kubernetes API, and determines the active distribution, provider, and cluster name from the kubeconfig context. It distinguishes KSail-managed GitOps resources from unrelated ones to avoid interfering with external GitOps setups. |
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
Removes implementation-level details from
docs/src/content/docs/architecture.mdxthat are too granular for an end-user architecture page.Bloat removed
What's preserved
Why this is bloat
These are implementation internals that belong in
CONTRIBUTING.md, not in an end-user architecture page. The page already explicitly references CONTRIBUTING.md for "contributor-level internals (package layout, internal APIs, source structure)". This change aligns the content with that stated scope.Line count: 174 → 168 lines (6 lines removed from the stability check section)