Skip to content

doc: improve README to try operator-sdk #2317

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
Dec 11, 2019

Conversation

shamsher31
Copy link
Contributor

Description of the change:
To avoid confusion for new user trying operator-sdk, Improve README and replace example with <username>.

Also add step to login to public registry like quay.io. If user is not logged in through CLI, He will face following error

quay unauthorized: access to the requested resource is not authorized

After login push work seamlessly.

Motivation for the change:
This will improve user experience for trying operator-sdk for the first time.

To [avoid confusion for new user](operator-framework#1337) trying `operator-sdk`, Improve README and replace `example` with `<username>`. 

Also add step to login to public registry like quay.io. If user is not logged in through CLI, He will face following error

`quay unauthorized: access to the requested resource is not authorized`

After login push work seamlessly.
@openshift-ci-robot openshift-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Dec 11, 2019
@shamsher31 shamsher31 changed the title Improve README to try operator-sdk doc: improve README to try operator-sdk Dec 11, 2019
Copy link
Contributor

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

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

thank you for the contribution.

It is /lgtm /approved for me.

@jmccormick2001
Copy link
Contributor

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Dec 11, 2019
@jmccormick2001 jmccormick2001 self-requested a review December 11, 2019 13:40
@camilamacedo86 camilamacedo86 merged commit f9cb4c7 into operator-framework:master Dec 11, 2019
@shamsher31 shamsher31 deleted the patch-2 branch April 23, 2020 12:26
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. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants