Refactor documentation #1786
Merged
Refactor documentation #1786
Conversation
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
k8s-ci-robot
added
the
area/provider/ibmcloud
k8s-ci-robot
added
cncf-cla: yes
✅ Deploy Preview for kubernetes-sigs-cluster-api-ibmcloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
k8s-ci-robot
added
size/S
|
/hold |
k8s-ci-robot
added
the
do-not-merge/hold
k8s-ci-robot
added
the
do-not-merge/work-in-progress
k8s-ci-robot
added
size/M
Amulyam24
changed the title
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
Amulyam24
changed the title
|
/hold cancel |
k8s-ci-robot
removed
the
do-not-merge/hold
Karthik-K-N
reviewed
May 21, 2024
Amulyam24
force-pushed
the
doc
branch
2 times, most recently
from
5744637 to
f3365e1
Compare
Amulyam24
changed the title
k8s-ci-robot
added
the
do-not-merge/work-in-progress
Amulyam24
changed the title
Karthik-K-N
reviewed
Jun 20, 2024
|
/cc @dharaneeshvrd @Prajyot-Parab ptal |
| --control-plane-machine-count=3 \ | ||
| --worker-machine-count=1 \ | ||
| --flavor=powervs | kubectl apply -f - | ||
| ``` |
There was a problem hiding this comment.
Can we add more content here on explaining the usage of existing resources and the different combinations user can pass like TG, VPC and PowerVS service instance?
There was a problem hiding this comment.
Currently the user provided TG expects to have both PowerVS and VPC connections.
- When connections are not there create the connection and during delete phase clean up only the connection. It requires another field to be added in status to mark whether connection is created by controller or not.
- We can expect combination of powervs, vpc and Tg to be passed and their connection should already be there.
If we are going with 2nd approach, we need to document that. IMO we can go with second approach and keep things simple for reuse approach.
Wdyt? @Amulyam24 @Karthik-K-N @mkumatag
There was a problem hiding this comment.
Yeah, I think its better to go with second approach and document it.
There was a problem hiding this comment.
Currently the user provided TG expects to have both PowerVS and VPC connections.
- When connections are not there create the connection and during delete phase clean up only the connection. It requires another field to be added in status to mark whether connection is created by controller or not.
- We can expect combination of powervs, vpc and Tg to be passed and their connection should already be there.
If we are going with 2nd approach, we need to document that. IMO we can go with second approach and keep things simple for reuse approach.
Wdyt? @Amulyam24 @Karthik-K-N @mkumatag
I don't think this is relevant with the latest code which supports all combinations of TG. Added a generic comment, PTAL
k8s-ci-robot
added
the
needs-rebase
|
The Kubernetes project currently lacks enough contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
k8s-ci-robot
added
the
lifecycle/stale
|
/remove-lifecycle stale |
k8s-ci-robot
removed
the
lifecycle/stale
k8s-ci-robot
removed
the
needs-rebase
|
@Karthik-K-N @dharaneeshvrd PR is ready for review, PTAL! |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Amulyam24, Prajyot-Parab The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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.
What this PR does / why we need it:
This PR refactors the documentation for
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 #
Special notes for your reviewer:
/area provider/ibmcloud
Release note: