Skip to content
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 installation/uninstallation docs #2784

Merged
merged 2 commits into from
May 26, 2022

Conversation

nsapse
Copy link
Contributor

@nsapse nsapse commented May 25, 2022

Description of the change:

Updates installation document to mention operator-sdk olm [install/uninstall]. Separate commit fixes small unrelated spelling error found in documents.

Motivation for the change:

Users have repeatedly asked for an uninstall.sh script as a means of uninstalling OLM. We should point users in the direction of currently existing and actively maintained functionality for that purpose.

Reviewer Checklist

  • Implementation matches the proposed design, or proposal is updated to match implementation
  • Sufficient unit test coverage
  • Sufficient end-to-end test coverage
  • Docs updated or added to /doc
  • Commit messages sensible and descriptive
  • Tests marked as [FLAKE] are truly flaky
  • Tests that remove the [FLAKE] tag are no longer flaky

Changes "exmaple" to "example"

Signed-off-by: Noah Sapse <nsapse@gmail.com>
doc/install/install.md Outdated Show resolved Hide resolved
doc/install/install.md Outdated Show resolved Hide resolved
Copy link
Contributor

@tylerslaton tylerslaton left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label May 25, 2022
- Closes operator-framework#2662
- Updates installation document to include `operator-sdk olm install` as
  an install method
- Updates installation document to include `operator-sdk olm uninstall`
  as an uninstall method

Signed-off-by: Noah Sapse <nsapse@gmail.com>
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label May 26, 2022
Copy link
Member

@exdx exdx left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label May 26, 2022
@openshift-ci
Copy link

openshift-ci bot commented May 26, 2022

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: exdx, nsapse, tylerslaton
To complete the pull request process, please assign ecordell after the PR has been reviewed.
You can assign the PR to them by writing /assign @ecordell in a comment when ready.

The full list of commands accepted by this bot can be found here.

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

@nsapse nsapse merged commit dd06812 into operator-framework:master May 26, 2022
nsapse added a commit to nsapse/operator-lifecycle-manager that referenced this pull request Jun 1, 2022
* Fix spelling error

Changes "exmaple" to "example"

Signed-off-by: Noah Sapse <nsapse@gmail.com>

* Updates Installation/Uninstallation Documents

- Closes operator-framework#2662
- Updates installation document to include `operator-sdk olm install` as
  an install method
- Updates installation document to include `operator-sdk olm uninstall`
  as an uninstall method

Signed-off-by: Noah Sapse <nsapse@gmail.com>
nsapse added a commit to nsapse/operator-lifecycle-manager that referenced this pull request Jun 1, 2022
* Fix spelling error

Changes "exmaple" to "example"

Signed-off-by: Noah Sapse <nsapse@gmail.com>

* Updates Installation/Uninstallation Documents

- Closes operator-framework#2662
- Updates installation document to include `operator-sdk olm install` as
  an install method
- Updates installation document to include `operator-sdk olm uninstall`
  as an uninstall method

Signed-off-by: Noah Sapse <nsapse@gmail.com>
nsapse added a commit to nsapse/operator-lifecycle-manager that referenced this pull request Jun 1, 2022
* Fix spelling error

Changes "exmaple" to "example"

Signed-off-by: Noah Sapse <nsapse@gmail.com>

* Updates Installation/Uninstallation Documents

- Closes operator-framework#2662
- Updates installation document to include `operator-sdk olm install` as
  an install method
- Updates installation document to include `operator-sdk olm uninstall`
  as an uninstall method

Signed-off-by: Noah Sapse <nsapse@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants