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

docs/design: Minor documentation fixes #546

Merged
merged 2 commits into from
Feb 17, 2021

Conversation

timflannagan
Copy link
Member

Description of the change:
General documentation updates/fixes/etc.

  • Fix some misspelled words
  • Update some of the wording and phrasing
  • Fix some of the markdown linting issues

Motivation for the change:

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 /docs
  • Commit messages sensible and descriptive

Copy link

@hasbro17 hasbro17 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-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 11, 2021
@openshift-ci-robot openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Jan 19, 2021
@codecov
Copy link

codecov bot commented Jan 19, 2021

Codecov Report

Merging #546 (580c36f) into master (eb9fff5) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #546   +/-   ##
=======================================
  Coverage   48.86%   48.86%           
=======================================
  Files          90       90           
  Lines        6260     6260           
=======================================
  Hits         3059     3059           
  Misses       2519     2519           
  Partials      682      682           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eb9fff5...580c36f. Read the comment docs.

@timflannagan
Copy link
Member Author

Looks like the e2e-* actions are failing due to a recent change: actions/runner-images#2703

```

Now, a binary named `opm` is now built in current directory and ready to be used.

Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason to remove this section?

Copy link
Member Author

Choose a reason for hiding this comment

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

I was just going based on what Kevin was saying in #546 (comment)

Copy link
Member

Choose a reason for hiding this comment

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

I see. I commented on the PR that Kevin mentioned. I'm against removing those alpha commands from opm. They are under alpha and not visible for a reason as they are meant for internal/testing/development use. We don't promote those commands as well because SDK is the official tool.
Those commands are frankly a way for us to rapid-test the changes we make to the library we have in registry repo.
Either way, it is OK to remove that section for now. We can always add it back.

Copy link
Member

@dinhxuanvu dinhxuanvu 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-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 17, 2021
@openshift-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dinhxuanvu, hasbro17, timflannagan

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 17, 2021
@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@timflannagan
Copy link
Member Author

It looks like this is using the old .github test workflow that was fixed recently due to upgrading the default podman version to the latest version before running the core test content. I tried manually re-running those jobs, but it still seems like it's stuck running an out-of-date workflow. Going to try and close and re-open.

@timflannagan
Copy link
Member Author

Interesting, well it looks like the new workflows have been picked up, but we're still silently erroring while installing pre-test depdencies:

time="2021-02-17T21:45:33Z" level=warning msg="Failed to add podman to systemd sandbox cgroup: exec: \"dbus-launch\": executable file not found in $PATH"

@timflannagan
Copy link
Member Author

/override ci/prow/e2e-aws

@openshift-ci-robot
Copy link

@timflannagan: Overrode contexts on behalf of timflannagan: ci/prow/e2e-aws

In response to this:

/override ci/prow/e2e-aws

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.

@timflannagan
Copy link
Member Author

/override e2e-kind e2e-minikube

@openshift-ci-robot
Copy link

@timflannagan: /override requires a failed status context to operate on.
The following unknown contexts were given:

  • e2e-kind e2e-minikube

Only the following contexts were expected:

  • ci/prow/e2e-aws
  • ci/prow/images
  • ci/prow/unit
  • tide

In response to this:

/override e2e-kind e2e-minikube

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-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@timflannagan
Copy link
Member Author

I'm going to force this through as this only touches documentation and nothing user-facing. I'm not entirely sure if you're able to override any failed tests through Github actions like you are able to do with tests configured by prow.

@timflannagan timflannagan merged commit 7413308 into operator-framework:master Feb 17, 2021
@timflannagan timflannagan deleted the minor-doc-fixes branch February 17, 2021 23:28
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.

6 participants