Optimize the module structure of the xtable

daragu commented 1 month ago

Feature Request / Improvement

add same prefix to sub modules
let the folder name of the module to match the artifactId

Changes

api -> xtable-api
core -> xtable-core
hudi-support -> xtable-hudi-support
utilities -> xtable-utilities
website -> xtable-website

Are you willing to submit PR?

[X] Yes I am willing to submit a PR!

Code of Conduct

[X] I agree to follow this project's Code of Conduct

daragu commented 1 month ago

hi @the-other-tim-brown @sagarlakshmipathy @vinishjail97, what do you think?

https://github.com/daragu/incubator-xtable/tree/module

the-other-tim-brown commented 1 month ago

What is the enhancement that comes with this? It feels a bit arbitrary.

daragu commented 1 month ago

What is the enhancement that comes with this? It feels a bit arbitrary.

Hi @the-other-tim-brown, well, I think I& a couple of points.

For mvn projects, add same prefix to sub modules is friendly for developers.
- Development best practices: it is impossible to deploy two modules having the same name. To avoid this kind of conflict, we recommend to prefix all modules of a project by a common key referring to the project (example : "xtable-aaa, xtable-bbb").
- After this modification, developers can quickly determine which folders in this project are submodules and which folders are regular folders by using the prefix of the folder e.g
- https://github.com/apache/flink
- https://github.com/apache/hudi
- https://github.com/apache/paimon
- https://github.com/spring-projects/spring-framework

For Xtable project users

From the official docs, user will use utilities/target/utilities-0.1.0-SNAPSHOT-bundled.jar to convert data lake formats

java -jar utilities/target/utilities-0.1.0-SNAPSHOT-bundled.jar --datasetConfig my_config.yaml

The name utilities-0.1.0-SNAPSHOT-bundled.jar does not have recognizability. The new name xtable-utilities-0.1.0-SNAPSHOT-bundled.jar is more recognizable.

the-other-tim-brown commented 1 month ago

@daragu thanks for the references and explanation. The changes sound good to me. The only thing is that the website directory is not maven module. Should that just stay as website for now? It may be moved in the future when we rethink how to manage the docs.

daragu commented 1 month ago

OK, the website directory will stay as website in the pullrequest.

apache / incubator-xtable