Skip to content

fix: update README to point to the OLM book website #1611

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

Merged
merged 1 commit into from
Jun 29, 2020

Conversation

exdx
Copy link
Member

@exdx exdx commented Jun 26, 2020

Description of the change:

Motivation for the change:
A new user coming to the OLM repo and reading the README would be interested in the OLM book. The link we provide should point to the OLM book itself, not the git repo backing the content. This makes for a better user experience for someone looking into OLM for the first time.

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

@Bowenislandsong
Copy link
Member

should we put https://olm.operatorframework.io/ on there?

Copy link
Member

@awgreene awgreene 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 Jun 26, 2020
@openshift-ci-robot
Copy link
Collaborator

openshift-ci-robot commented Jun 26, 2020

@exdx: The following tests failed, say /retest to rerun all failed tests:

Test name Commit Details Rerun command
ci/prow/images 3493ed1 link /test images
ci/prow/e2e-gcp 3493ed1 link /test e2e-gcp
ci/prow/e2e-gcp-upgrade 3493ed1 link /test e2e-gcp-upgrade
ci/prow/e2e-aws-olm 3493ed1 link /test e2e-aws-olm

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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.

@njhale
Copy link
Member

njhale commented Jun 29, 2020

/retest
/approve

@openshift-ci-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: exdx, njhale

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 Jun 29, 2020
@exdx
Copy link
Member Author

exdx commented Jun 29, 2020

will manually merge as this is doc-only (only updates a link in the README).

@exdx exdx merged commit afd2348 into operator-framework:master Jun 29, 2020
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.

5 participants