Skip to content

Point MachineSet references to the official documentation in the Red Hat released CSV#1232

Merged
openshift-merge-robot merged 1 commit into
openshift:masterfrom
jrvaldes:fix-csv-links
Oct 3, 2022
Merged

Point MachineSet references to the official documentation in the Red Hat released CSV#1232
openshift-merge-robot merged 1 commit into
openshift:masterfrom
jrvaldes:fix-csv-links

Conversation

@jrvaldes
Copy link
Copy Markdown
Contributor

@jrvaldes jrvaldes commented Sep 2, 2022

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

@openshift-ci openshift-ci Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 2, 2022
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented Sep 2, 2022

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@jrvaldes jrvaldes marked this pull request as ready for review September 2, 2022 15:09
@openshift-ci openshift-ci Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 2, 2022
@jrvaldes
Copy link
Copy Markdown
Contributor Author

jrvaldes commented Sep 2, 2022

/hold

depends on #1230 to unblock CI

@openshift-ci openshift-ci Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 2, 2022
@openshift-cherrypick-robot
Copy link
Copy Markdown

@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.

Details

In response to this:

/cherry-pick release-4.11

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.

@saifshaikh48
Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Sep 2, 2022
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)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a stance on what these links should be for the community vs Red Hat operator?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we said community docs should link to our github repo, but @openshift/openshift-team-windows-containers please confirm

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 latest official docs (less maintenance). GitHub may be fine too.

Copy link
Copy Markdown
Member

@mansikulkarni96 mansikulkarni96 Sep 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have been pointing to github docs for community operator and official docs for RH operator.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we updating this? Is this so that OpenShift docs are reflected in the Red Hat operator?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To use OpenShift docs in the Red Hat operator CSV

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for highlighting this. Commit message updated.

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 23, 2022
@openshift-ci openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Sep 28, 2022
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 28, 2022
@jrvaldes jrvaldes changed the title [deploy] Update links to official docs Point MachineSet references to the official documentation in the CSV Sep 28, 2022
@jrvaldes
Copy link
Copy Markdown
Contributor Author

/hold cancel

@openshift-ci openshift-ci Bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 28, 2022
@saifshaikh48
Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Sep 28, 2022
@jrvaldes jrvaldes changed the title Point MachineSet references to the official documentation in the CSV Point MachineSet references to the official documentation in the Red Hat released CSV Sep 29, 2022
@openshift-ci openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Sep 29, 2022
- [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)
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

creating-windows-machineset-gcp.html is proposed in openshift/openshift-docs#49719

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented Sep 29, 2022

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 29, 2022
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
@jrvaldes
Copy link
Copy Markdown
Contributor Author

jrvaldes commented Oct 3, 2022

/test gcp-e2e-operator

Failed deprovisioning cluster

@aravindhp
Copy link
Copy Markdown
Contributor

/override ci/prow/gcp-e2e-operator

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented Oct 3, 2022

@aravindhp: Overrode contexts on behalf of aravindhp: ci/prow/gcp-e2e-operator

Details

In response to this:

/override ci/prow/gcp-e2e-operator

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.

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented Oct 3, 2022

@jrvaldes: all tests passed!

Full PR test history. Your PR dashboard.

Details

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. I understand the commands that are listed here.

@sebsoto
Copy link
Copy Markdown
Contributor

sebsoto commented Oct 3, 2022

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Oct 3, 2022
@openshift-merge-robot openshift-merge-robot merged commit 01499ac into openshift:master Oct 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants