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.

Sign up for GitHub

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

Jump to bottom

Provide a detailed documentation of operator-sdk CLI #266

Closed
fanminshi opened this issue May 18, 2018 · 1 comment
Closed

Provide a detailed documentation of operator-sdk CLI #266

fanminshi opened this issue May 18, 2018 · 1 comment

Comments

@fanminshi
Copy link
Contributor

fanminshi commented May 18, 2018 •
edited
Loading

Currently, It might not be clear on what each operator-sdk CLI command does and when it should be used. Some of the commands are briefly explained in the user_guide but not all.
We should have a detailed doc sdk-cli-reference.md to explain operator-sdk CLI usage.
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 18, 2018
@srleyva
docs: add docs for cli cmd build
9d02819 
started documentation for operator-sdk and added docs for build cmd

Fixes operator-framework#266
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 18, 2018
@srleyva
doc/user-guide.md: add docs for cli cmd build
dd0fefe 
started documentation for operator-sdk and added docs for build cmd

Fixes operator-framework#266
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 18, 2018
@srleyva
doc/user-guide.md: add docs for cli cmd build
7ce89c1 
started documentation for operator-sdk and added docs for build cmd

Fixes operator-framework#266
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 18, 2018
@srleyva
doc/user-guide.md: add docs for cli cmd build
ccb9047 
started documentation for operator-sdk and added docs for build cmd

Fixes operator-framework#266
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 18, 2018
@srleyva
doc/user-guide.md: add docs for cli cmd build
6c85321 
started documentation for operator-sdk and added docs for build cmd

Fixes operator-framework#266
@srleyva srleyva mentioned this issue May 18, 2018
Merged
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 18, 2018
@srleyva
doc/user-guide.md: add docs for cli cmd build
7d67170 
started documentation for operator-sdk and added docs for build cmd

Fixes operator-framework#266
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 18, 2018
@srleyva
doc/user-guide.md: add docs for cli cmd build
c4eb971 
started documentation for operator-sdk and added docs for build cmd

Fixes operator-framework#266
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 18, 2018
@srleyva
doc/sdk-cli-reference.md: add docs for cli cmd build
23e7ebb 
started documentation for operator-sdk and added docs for build cmd

Fixes operator-framework#266
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 18, 2018
@srleyva
doc/sdk-cli-reference.md: add docs for cli
3f40016 
added detailed docs for operator-sdk cli commands

Fixes operator-framework#266
@fanminshi fanminshi mentioned this issue May 24, 2018
Merged
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 25, 2018
@srleyva
doc/sdk-cli-reference.md: add docs for cli
f4fbc54 
added detailed docs for operator-sdk cli commands

Fixes operator-framework#266
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 25, 2018
@srleyva
doc/sdk-cli-reference.md: add docs for cli
d396691 
added detailed docs for operator-sdk cli commands

Fixes operator-framework#266
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 25, 2018
@srleyva
doc/sdk-cli-reference.md: add docs for cli
56f3be9 
added detailed docs for operator-sdk cli commands

Fixes operator-framework#266
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 25, 2018
@srleyva
doc/sdk-cli-reference.md: add docs for cli
44d461c 
added detailed docs for operator-sdk cli commands

Fixes operator-framework#266
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 25, 2018
@srleyva
doc/sdk-cli-reference.md: add docs for cli
902ed0e 
added detailed docs for operator-sdk cli commands

Fixes operator-framework#266
srleyva added a commit to srleyva/operator-sdk that referenced this issue May 25, 2018
@srleyva
doc/sdk-cli-reference.md: add docs for cli
d4199e7 
added detailed docs for operator-sdk cli commands

Fixes operator-framework#266
@fanminshi
Copy link
Contributor Author

fanminshi commented May 25, 2018 •
edited
Loading

Sub Tasks:

  • provide detailed example for operator-sdk up local command. cc/ @shawn-hurley

@fanminshi fanminshi reopened this May 25, 2018
shawn-hurley pushed a commit to shawn-hurley/operator-sdk that referenced this issue Jun 1, 2018
doc/sdk-cli-reference: Adding details for up/local command.
fb7db7f 
adds details and more examples for `operator-sdk up local` flags

Fixes operator-framework#266
@shawn-hurley shawn-hurley mentioned this issue Jun 1, 2018
Merged
shawn-hurley pushed a commit to shawn-hurley/operator-sdk that referenced this issue Jun 4, 2018
doc/sdk-cli-reference: Adding details for up/local command.
f236cbe 
adds details and more examples for `operator-sdk up local` flags

Fixes operator-framework#266
shawn-hurley pushed a commit to shawn-hurley/operator-sdk that referenced this issue Jun 4, 2018
doc/sdk-cli-reference: Adding details for up/local command.
b11c0a5 
adds details and more examples for `operator-sdk up local` flags

Fixes operator-framework#266
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@fanminshi