-
Notifications
You must be signed in to change notification settings - Fork 1.4k
📖 Update in-place update implementation notes #13016
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📖 Update in-place update implementation notes #13016
Conversation
|
/area documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the PR.
i've added some comments on grammar. note that this is not a implementation correctness pass.
Q: i know that the CAPI book has a lot of details, but this seems like it's going trough the controller source code and covering everything. is the average reader that interested in documentation verbosity ALA "i what to know exactly how this works"? for comparison, the k8s documentation doesn't do that.
docs/proposals/20240807-in-place-updates-implementation-notes.md
Outdated
Show resolved
Hide resolved
docs/proposals/20240807-in-place-updates-implementation-notes.md
Outdated
Show resolved
Hide resolved
docs/proposals/20240807-in-place-updates-implementation-notes.md
Outdated
Show resolved
Hide resolved
docs/proposals/20240807-in-place-updates-implementation-notes.md
Outdated
Show resolved
Hide resolved
docs/proposals/20240807-in-place-updates-implementation-notes.md
Outdated
Show resolved
Hide resolved
docs/proposals/20240807-in-place-updates-implementation-notes.md
Outdated
Show resolved
Hide resolved
docs/proposals/20240807-in-place-updates-implementation-notes.md
Outdated
Show resolved
Hide resolved
docs/proposals/20240807-in-place-updates-implementation-notes.md
Outdated
Show resolved
Hide resolved
docs/proposals/20240807-in-place-updates-implementation-notes.md
Outdated
Show resolved
Hide resolved
docs/proposals/20240807-in-place-updates-implementation-notes.md
Outdated
Show resolved
Hide resolved
|
great work! |
84f84d1 to
340d674
Compare
|
@neolit123 Hey, I addressed your comments. A follow-up PR will be made to update the proposal and user-facing docs. These docs are for engineers working directly on the CAPI code to have a place to refer to in case knowledge transfer is needed. |
Signed-off-by: Alexandr Demicev <[email protected]>
340d674 to
fe8a308
Compare
|
/lgtm |
|
LGTM label has been added. DetailsGit tree hash: 664a4048a68ed2679f0181b35d2e8507dd495823 |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: fabriziopandini The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/cherry-pick release-1.12 |
|
@fabriziopandini: once the present PR merges, I will cherry-pick it on top of DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
@fabriziopandini: new pull request created: #13118 DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
What this PR does / why we need it:
This PR adds notes about KCP implementation and managed field refactoring. @sbueringer @fabriziopandini could you please verify that I didn't miss anything and got it all right, also I wasn't sure if we should move these notes into the proposal or keep them separated.
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #