Skip to content

Update README.md #668

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.

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

Merged
merged 4 commits into from
Sep 19, 2019
Merged

Update README.md #668

merged 4 commits into from
Sep 19, 2019

Conversation

andreyferriyan
Copy link
Contributor

Update README.md in installation section. To avoid error with different shell.

@ghost
Copy link

ghost commented Sep 19, 2019

It looks like @andreyferriyan hasn't signed our Contributor License Agreement, yet.

The purpose of a CLA is to ensure that the guardian of a project's outputs has the necessary ownership or grants of rights over all contributions to allow them to distribute under the chosen licence.
Wikipedia

You can read and sign our full Contributor License Agreement here.

Once you've signed reply with [clabot:check] to prove it.

Appreciation of efforts,

clabot

@andreyferriyan
Copy link
Contributor Author

It looks like @andreyferriyan hasn't signed our Contributor License Agreement, yet.

The purpose of a CLA is to ensure that the guardian of a project's outputs has the necessary ownership or grants of rights over all contributions to allow them to distribute under the chosen licence.
Wikipedia

You can read and sign our full Contributor License Agreement here.

Once you've signed reply with [clabot:check] to prove it.

Appreciation of efforts,

clabot

[clabot:check]

@ghost
Copy link

ghost commented Sep 19, 2019

@confluentinc It looks like @andreyferriyan just signed our Contributor License Agreement. 👍

Always at your service,

clabot

README.md Outdated

To avoid error in installation like *no matches found: confluent-kafka[avro]*, use double quotes. As an example:

$ pip install "confluent-kafka[avro]"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is better to just change the "pip install ..avro]" line above to include quotes, people tend to cutnpaste the first command they see

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, this is my first time to change. Where should I change the line ?. In my forking repo ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, undo your previous changes and modify the original pip install confluent-kafka[avro] line above to have quotes. Commit and push.

Copy link
Contributor Author

@andreyferriyan andreyferriyan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please check again

Copy link
Contributor

@edenhill edenhill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost good to go, just the remove whitespace changes you've made.

README.md Outdated

**Install from source from PyPi** *(requires librdkafka + dependencies to be installed separately)*:

$ pip install --no-binary :all: confluent-kafka


For source install, see *Prerequisites* below.
For source install, see *Prerequisites* below.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove the whitespace diff

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whitespace change needs to be removed too.

Copy link
Contributor Author

@andreyferriyan andreyferriyan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about like this ?

Copy link
Contributor Author

@andreyferriyan andreyferriyan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hope this is okay, hehe.

Copy link
Contributor

@edenhill edenhill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect :)

@edenhill edenhill merged commit d56ea3e into confluentinc:master Sep 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants