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

More Complete Module Documentation for those who are new and Unfamiliar of the Project and the Different Maven Artifacts #24

Open
sirinath opened this issue Jun 20, 2020 · 0 comments

Comments

@sirinath
Copy link

sirinath commented Jun 20, 2020

There are 61 Maven artefacts: https://mvnrepository.com/artifact/io.datakernel?p=1&sort=newest

Some artefacts are very similar in name. E.g.: datakernel-launchers-common, datakernel-launchers-http, http-launchers, datakernel-launcher, datakernel-http.

This is making it confusing what artefacts to add to the project as https://datakernel.io/docs/core/http.html does not give what dependencies to add.

Assuming datakernel-launchers-common refers to: https://github.com/softindex/datakernel/tree/master/launchers/common there is no readme there also specifying what this does.

Elsewhere also the documentation is very thin: https://github.com/softindex/datakernel/tree/master/core-http and the referring link is broken: https://datakernel.io/docs/components/core/http.html

Also, some module documentation does not refer to what the relevant artefacts are. E.g. https://datakernel.io/docs/core/http.html

@sirinath sirinath changed the title More Complete Module Documentation More Complete Module Documentation for those who are new and Unfamiliar of the Project and the Different Maven Artifacts Jun 20, 2020
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

No branches or pull requests

1 participant