Add minimum requirements sections to notifications docs #4328
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
|
@donatello, thanks for your PR! By analyzing the history of the files in this pull request, we identified @harshavardhana and @nitisht to be potential reviewers. |
Codecov Report
@@ Coverage Diff @@
## master #4328 +/- ##
=========================================
+ Coverage 65.84% 66.64% +0.8%
=========================================
Files 173 176 +3
Lines 18884 25074 +6190
=========================================
+ Hits 12434 16711 +4277
- Misses 5321 7237 +1916
+ Partials 1129 1126 -3
Continue to review full report at Codecov.
|
deekoder
suggested changes
May 11, 2017
docs/bucket/notifications/README.md
Outdated
| @@ -464,6 +467,10 @@ When the _access_ format is used, Minio appends events to a table. It creates ro | |||
|
|
|||
| The steps below show how to use this notification target in `namespace` format. The other format is very similar and is omitted for brevity. | |||
|
|
|||
| ### Step 0: Ensure minimum requirements are met | |||
There was a problem hiding this comment.
Hate to nitpick. Please use step 1, step 2 instead of 0, 1. Just to be consistent with other docs.
docs/bucket/notifications/README.md
Outdated
| @@ -557,6 +564,10 @@ When the _access_ format is used, Minio appends events to a table. It creates ro | |||
|
|
|||
| The steps below show how to use this notification target in `namespace` format. The other format is very similar and is omitted for brevity. | |||
|
|
|||
| ### Step 0: Ensure minimum requirements are met | |||
deekoder
previously approved these changes
May 11, 2017
nitisht
reviewed
May 11, 2017
docs/bucket/notifications/README.md
Outdated
|
|
||
| ### Step 1: Add kafka endpoint to Minio | ||
| We tested Minio with Kafka version version 0.10.1.0. More recent versions should also work. Internally Minio uses the [Shopify/sarama](https://github.com/Shopify/sarama/) library distributed from [gopkg.in](http://gopkg.in/Shopify/sarama.v1), and any version supported by that library should work. |
There was a problem hiding this comment.
Text here is a little vague, can you try to be specific about the supported version?
nitisht
approved these changes
May 11, 2017
deekoder
approved these changes
May 12, 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.
Description
Adds extra info in docs about minimum versions of external notification targets
Motivation and Context
Improve docs
Checklist: