Point MachineSet references to the official documentation in the Red Hat released CSV#1232
Conversation
|
Skipping CI for Draft Pull Request. |
32986d8 to
6f552df
Compare
|
/hold depends on #1230 to unblock CI |
|
@jrvaldes: once the present PR merges, I will cherry-pick it on top of release-4.11 in a new PR and assign it to you. 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/test-infra repository. |
|
/lgtm |
| Example MachineSet for other cloud providers: | ||
| - [AWS](https://github.com/openshift/windows-machine-config-operator/blob/master/docs/machineset-aws.md) | ||
| - [Azure](https://github.com/openshift/windows-machine-config-operator/blob/master/docs/machineset-azure.md) | ||
| - [AWS](https://docs.openshift.com/container-platform/4.11/windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.html) |
There was a problem hiding this comment.
Do we have a stance on what these links should be for the community vs Red Hat operator?
There was a problem hiding this comment.
I think we said community docs should link to our github repo, but @openshift/openshift-team-windows-containers please confirm
There was a problem hiding this comment.
Do we have a stance on what these links should be for the community vs Red Hat operator?
Not sure if we discussed community doc links in the past. My two cents:
- Links for Red Hat operator should point to official docs
- Links for the community may also point to the
latestofficial docs (less maintenance). GitHub may be fine too.
There was a problem hiding this comment.
We have been pointing to github docs for community operator and official docs for RH operator.
There was a problem hiding this comment.
We have been pointing to github docs for community operator and official docs for RH opera
This is the correct approach. We should not link the community CSV to the official docs. It is not about maintenance but about being able to release features quicker that won't have official docs.
There was a problem hiding this comment.
Why are we updating this? Is this so that OpenShift docs are reflected in the Red Hat operator?
There was a problem hiding this comment.
To use OpenShift docs in the Red Hat operator CSV
There was a problem hiding this comment.
Then please call that out. Our PRs and commits should say WHAT is being done and WHY. I am noticing quite a few commits where the WHY is missing.
There was a problem hiding this comment.
Thanks for highlighting this. Commit message updated.
6f552df to
9793968
Compare
|
/hold cancel |
|
/lgtm |
9793968 to
84449ae
Compare
| - [GCP](https://github.com/openshift/windows-machine-config-operator/blob/master/docs/machineset-gcp.md) | ||
| - [AWS](https://docs.openshift.com/container-platform/4.12/windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.html) | ||
| - [Azure](https://docs.openshift.com/container-platform/4.12/windows_containers/creating_windows_machinesets/creating-windows-machineset-azure.html) | ||
| - [GCP](https://docs.openshift.com/container-platform/4.12/windows_containers/creating_windows_machinesets/creating-windows-machineset-gcp.html) |
There was a problem hiding this comment.
creating-windows-machineset-gcp.html is proposed in openshift/openshift-docs#49719
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: aravindhp, jrvaldes 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 |
This change links the MachineSet references in the Red Hat released CSV to the official OpenShift docs, so that the Red Hat released operator in the OperatorHub for OCP points to the appropriated documentation. The links to the WMCO repository in GitHub remain as supporting information for the community released CSV. Ran: make bundle
84449ae to
d552ac1
Compare
|
/test gcp-e2e-operator Failed deprovisioning cluster |
|
/override ci/prow/gcp-e2e-operator |
|
@aravindhp: Overrode contexts on behalf of aravindhp: ci/prow/gcp-e2e-operator 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/test-infra repository. |
|
@jrvaldes: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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/test-infra repository. I understand the commands that are listed here. |
|
/lgtm |
This change links the MachineSet references in the Red Hat released CSV to
the official OpenShift docs, so that the Red Hat released operator in the
OperatorHub for OCP points to the appropriated documentation. The links to
the WMCO repository in GitHub remain as supporting information for the
community released CSV.
Ran: