Cleanup Mint README doc #140
Merged
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
nitisht
force-pushed
the
doc-cleanup
branch
3 times, most recently
from
d19572c
to
ac23b7a
Compare
poornas
reviewed
Sep 18, 2017
README.md
Outdated
| @@ -1,41 +1,16 @@ | |||
| # Mint [](https://slack.minio.io) [](https://hub.docker.com/r/minio/mint/) | |||
|
|
|||
| Collection of tests to detect overall correctness of Minio server. | |||
| Mint detects overall correctness of Minio server, using Minio SDKs, minio client (mc), AWS SDKs and awscli. Use Mint to test Minio server instances for functional correctness. | |||
There was a problem hiding this comment.
comma between Minio server and using Minio SDKs can be removed.
README.md
Outdated
| |:--- |:--- | | ||
| |`name`| Name of SDK being tested | | ||
| |`function`| API signature being tested by the test case | | ||
| |`args`| Key value map of arguments being passed in the API being tests. Note that this is not exhaustive, and only significant arguments will be listed | |
There was a problem hiding this comment.
being passed in the API being tests ->redundant "being"
README.md
Outdated
| ### Build using Travis | ||
|
|
||
| Each pull request when submitted to Github `travis-ci` runs build on mint to create new docker image on `play.minio.io`, our private docker registry. You can get the `mint` image associated with your pull request by just running `docker pull play.minio.io/mint:$PULL_REQUEST_SHA`. For example | ||
| **Note for Developers**: On each PR send to [Mint repository](https://github.com/minio/mint), `travis-ci` builds `mint` docker image and pushes it to `play.minio.io`, our private docker registry. You can get the `mint` image associated with your pull request by just running `docker pull play.minio.io/mint:$PULL_REQUEST_SHA`. For example |
nitisht
force-pushed
the
doc-cleanup
branch
from
ac23b7a
to
c718e87
Compare
|
done @poornas |
poornas
approved these changes
Sep 18, 2017
nitisht
requested review from
harshavardhana
and removed request for
deekoder
harshavardhana
approved these changes
Sep 19, 2017
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.
Fixes #135