WallarooLabs / wally

Distributed Stream Processing
https://www.wallaroolabs.com
Apache License 2.0
1.48k stars 68 forks source link

Release testing: Celsius-Kafka README updates #2365

Open rachelblasucci opened 6 years ago

rachelblasucci commented 6 years ago

1) Small thing, but it would be useful for the README from the celsius-kafka application to mention switching directories in the Shell 3 step.

Specifically, something like:

Shell 3: Celsius-kafka Change to the application directory with: cd /src/wallaroo/examples/python/celsius Run machida with --application-module celsius:

instead of only:

Shell 3: Celsius-kafka Run machida with --application-module celsius:

2) With Shell 2: The sentence, "Set up a listener to monitor the Kafka topic to which you would the application to publish results." should be rephrased.

3) For me, both this time and last release, running the ./cluster up 1 didn't start up local_kafka_1_1. Re-running the command worked. Perhaps mention this could happen?

2359

rachelblasucci commented 6 years ago

I think I had leftover files from the last time I tested the kafka bits. Number 3 isn't an issue. :-)

dipinhora commented 6 years ago

@rachelblasucci Re: bullet 1, the Running Celsius Kafka (https://github.com/WallarooLabs/wallaroo/tree/release-0.5.2/examples/python/celsius-kafka#running-celsius-kafka) instructs folks that all shells should be opened and then they should change to the examples/python/celsius-kafka directory. Do you think the additional note regarding changing the directory for shell 3 is also necessary?

rachelblasucci commented 6 years ago

Ah, yes, good point. I was running with Docker in this case.. So, I might consider clarifying the comment, somehow, as part of the previous statement:

NOTE: If running in Docker, the kafkfa cluster and kafkacat should be run from your host and not within the Docker container.

Or maybe just stating where it's really necessary to be in the correct folder?

rachelblasucci commented 6 years ago

@enilsen16 Would love feedback on this one, too. :)

dipinhora commented 6 years ago

item 2 is resolved by https://github.com/WallarooLabs/wallaroo/issues/2368

item 1 is not going to be part of 0.5.2 as there's no quick/easy way to make the README clear for both wallaroo in docker and wallaroo outside of docker users. This will have to be addressed separately after the release.

rachelblasucci commented 6 years ago

@enilsen16 @SeanTAllen Is this/Can the rest of this be addressed as part of the book changes coming up?

SeanTAllen commented 6 years ago

No. book changes would be purely organization, no content changes.