Update documentation to reflect build/push and v3 changes #648
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
cdrage
commented
Jun 15, 2017
•
cdrage
commented
k8s-ci-robot
added
the
cncf-cla: yes
cdrage
force-pushed
the
update-user-guide-with-build
branch
from
4200987 to
530f320
Compare
surajssd
reviewed
Jun 17, 2017
docs/user-guide.md
Outdated
| ```console | ||
| $ cd examples/ | ||
| ```sh | ||
| cd examples/ |
There was a problem hiding this comment.
please keep those $ otherwise it is hard to know which is command and which is output
There was a problem hiding this comment.
@surajssd Actually, it's harder to copy/paste if it stays... Most guides I've seen online don't include the $ which isn't exactly standard across all terminals (some people use fish, zsh, etc.)
cdrage
force-pushed
the
update-user-guide-with-build
branch
from
530f320 to
3a622aa
Compare
cdrage
changed the title
cdrage
force-pushed
the
update-user-guide-with-build
branch
from
3a622aa to
6409674
Compare
|
Updated it with your changes @surajssd ready for another doc review @kadel @surajssd or @surajnarwade |
cdrage
force-pushed
the
update-user-guide-with-build
branch
4 times, most recently
from
c5e01f0 to
1dc9659
Compare
docs/user-guide.md
Outdated
| @@ -78,7 +81,7 @@ INFO Kubernetes file "mongodb-claim0-persistentvolumeclaim.yaml" created | |||
| INFO Kubernetes file "redis-master-deployment.yaml" created | |||
| INFO Kubernetes file "redis-slave-deployment.yaml" created | |||
|
|
|||
| $ ls | |||
| ls | |||
|
@cdrage , only one comment, otherwise LGTM :) |
kadel
reviewed
Jun 21, 2017
docs/user-guide.md
Outdated
| ## Building and Pushing Docker Images | ||
|
|
||
| Kompose supports both building and pushing Docker images. When using the `build` key within your Docker Compose file, your image will automatically be built and pushed. | ||
|
|
There was a problem hiding this comment.
Maybe it's clear, but it might be good to add a sentence explaining where the image will be pushed to.
Adds a user guide on how to use the build/push functionality of Docker images to the user guide. Adds v3 documentation as well as cleans up the user guide as well. I also do minor changes such as removing `$ ` in the CLI examples, as it's easier to copy and paste without the `$ ` there (when double clicking). I've also changed the `console` yaml indicitors to `sh` since it doesn't matter / it's aliased, see: https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
cdrage
force-pushed
the
update-user-guide-with-build
branch
from
1dc9659 to
b903789
Compare
|
LGTM :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.