doc/user-guide.md: add docs for cli cmd build #267
Conversation
srleyva
force-pushed
the
cli-docs
branch
4 times, most recently
from
23e7ebb
to
3f40016
Compare
doc/sdk-cli-reference.md
Outdated
|
|
||
| ``` | ||
|
|
||
| ## up |
There was a problem hiding this comment.
The up command was recently updated with more feature. could you update the this doc along with those?
There was a problem hiding this comment.
Added the new features to the doc
srleyva
force-pushed
the
cli-docs
branch
3 times, most recently
from
d396691
to
56f3be9
Compare
srleyva
changed the title
| ##### Flags | ||
|
|
||
| * `-h, --help` - help for k8s | ||
|
|
There was a problem hiding this comment.
Maybe we could add an Example section for k8s command to be consistent
There was a problem hiding this comment.
Added it...also tried to keep the consistency in the generate olm-catalog doc as well.
Thanks for the suggestion!
|
|
||
| * `-h, --help` - help for local | ||
|
|
||
| ##### Example |
There was a problem hiding this comment.
I'll let @shawn-hurley to provide additional descriptions on how to use those flags as he worked on this in a future PR.
doc/sdk-cli-reference.md
Outdated
| ```bash | ||
| operator-sdk build quay.io/example/operator:v0.0.1 | ||
|
|
||
| // Output: |
There was a problem hiding this comment.
Could we use
# Output:
Instead of
// Output:Because I believe # is used for commenting in bash.
doc/sdk-cli-reference.md
Outdated
| ```bash | ||
| operator-sdk generate k8s | ||
|
|
||
| # Output |
doc/sdk-cli-reference.md
Outdated
| ```bash | ||
| operator-sdk generate olm-catalog --image=quay.io/example/operator:v0.0.1 --version=0.0.1 | ||
|
|
||
| # Output |
doc/sdk-cli-reference.md
Outdated
| cd $GOPATH/src/github.com/example.com/ | ||
| operator-sdk new app-operator --api-version=app.example.com/v1alpha1 --kind=AppService | ||
|
|
||
| //Output |
doc/sdk-cli-reference.md
Outdated
| //Output | ||
| Create app-operator/.gitignore | ||
| ... | ||
|
|
doc/sdk-cli-reference.md
Outdated
| # Output | ||
| Run code-generation for custom resources | ||
| Generating deepcopy funcs | ||
|
|
There was a problem hiding this comment.
No need to have the extra line here.
|
lgtm after nits. |
added detailed docs for operator-sdk cli commands Fixes operator-framework#266
|
Thanks for the help @fanminshi |
started documentation for operator-sdk and added docs for build cmd
Refers #266
Is this a good place for the CLI documentation? @fanminshi