Skip to content
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

Updates README to use YAML instead of XML #121

Merged
merged 2 commits into from
Jan 20, 2020

Conversation

alparslanavci
Copy link
Contributor

Fixes #96.

@alparslanavci alparslanavci added this to the 3.1 milestone Jan 17, 2020
@hasancelik
Copy link
Collaborator

I think we should keep XML config as a separate section. Most of our users still use XML configuration. WDYT? @alparslanavci @leszko

@alparslanavci
Copy link
Contributor Author

@hasancelik yes, we can keep them both, but I think it might be a good push to pass YAML config.

@hasancelik
Copy link
Collaborator

Afaik, IMDG core will continue to support XML for a long time so promoting YAML for Kubernetes service discovery is good idea but for AWS, I am not sure.

@nfrankel
Copy link

IMHO, XML is far superior to YAML, especially when the configuration is a bit large. That some want to use YAML is fine (...).

I'd suggest the documentation offers both, just as Spring does with Java and Kotlin support. Please see how it looks here: https://docs.spring.io/spring-framework/docs/5.2.x/spring-framework-reference/core.html#beans-factory-instantiation. There's one tab for Java, one for Kotlin so it doesn't impair readability.

Copy link

@leszko leszko left a comment

Choose a reason for hiding this comment

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

LGTM 👍

If you find a way to create tabs in GH Readme (like suggested by @nfrankel), then it's a good idea to have YAML/XML/Java as tabs. If not, then yeah, let's keep anyway all options in the config XML, YAML, and JAVA. We are moving to YAML everywhere, but @hasancelik is right that a lot of AWS users probably still use XML.

@alparslanavci
Copy link
Contributor Author

Ok, I added back the XML configuration samples.

@alparslanavci alparslanavci merged commit dfdb014 into hazelcast:master Jan 20, 2020
@alparslanavci alparslanavci deleted the issue#13 branch January 20, 2020 14:34
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.

Update README.md to use YAML instead of XML
4 participants