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
improvements in logging, examples and documentation #294
Conversation
Current coverage is
|
This PR does not add any new code to the adapter or worker projects other than logging. Code coverage number dropped probably because some of the methods updated with logging are not already covered by unit tests. Normally code coverage failure in a PR means it is not ready for merge. Since only log entries are added to the classes covered by CC in this PR, I would like to treat this as an exception. Let me me know if you have any concerns. |
|Run standlone examples in Client mode |[Quick-start wiki](https://github.com/Microsoft/SparkCLR/wiki/Quick-Start#client-mode) |[Quick-start wiki](https://github.com/Microsoft/SparkCLR/wiki/Quick-Start#client-mode) | | ||
|Run standlone examples in Cluster mode |[Quick-start wiki](https://github.com/Microsoft/SparkCLR/wiki/Quick-Start#cluster-mode) |[Quick-start wiki](https://github.com/Microsoft/SparkCLR/wiki/Quick-Start#cluster-mode) | | ||
|Run examples in local mode |[running-sparkclr-app.md](notes/running-sparkclr-app.md#running-examples-in-local-mode) |[running-sparkclr-app.md](notes/running-sparkclr-app.md#linux-instructions) | | ||
|Run SparkCLR app in standalone cluster |[running-sparkclr-app.md](notes/running-sparkclr-app.md#standalone-cluster) |[running-sparkclr-app.md](notes/running-sparkclr-app.md#linux-instructions) | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We may want to be consistent with either "examples" or "SparkCLR app". So the reader knows that, the examples can run in all three environments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, the idea is that beginners might want to try out examples in local mode. When they are past that stage, they might want to tweak examples and run their apps in spark cluster. Agree that we need to make it clear that examples can be run anywhere. Will add a note on that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we just say "Run SparkCLR app in local mode", with actual md talks about examples in local mode/standalone cluster/yarn cluster, the reader will just get it.
Agreed with codecov exception. |
improvements in logging, examples and documentation
three commits each covering improvements in one area