Fixing the Docker install process, including solutions and details

[vincemulhollon]

Describe the bug
The docker install process is broken.

To Reproduce
Steps to reproduce the behavior:

1. Follow any of the multiple separate, different installation instructions.
2. Install will not succeed.

Expected behavior
The same instructions are available at all locations and URLs, and the instructions work.

Screenshots
If applicable, add screenshots to help explain your problem.

Version of Kapua
1.5.x although really all of them

Type of deployment
[ XXX] Docker
[ ] Openshift (in its variants)
[ ] Others

Main component affected
[ ] Console (in case of console please report info on which browser you encountered the problem)
[ ] REST API
[ ] Message Broker
[XXX] - Others: ALL of them I guess?

Additional context

https://github.com/eclipse/kapua/blob/develop/README.md

This set of instructions will pull in "develop" as the default branch and running ./deployment/docker/unix/docker-deploy.sh will fail as there is no telemetry module available for download at docker hub.

I think this file can be fixed by adding a line "git checkout release-1.5.x" (or similar) after "Open an OS shell and move to Kapua project root directory" and before "Start Docker runtime" and then installation works perfectly.

https://www.eclipse.org/kapua/getting-started.php

I don't know where these instructions come from but they should be updated to match the above.

I think that this:

https://github.com/eclipse/kapua/blob/develop/docs/developer-guide/en/running.md

Is the source code for this URL:

https://download.eclipse.org/kapua/docs/develop/developer-guide/en/running.html

And again this should all be updated to match as per above.

I would propose that you want to make the readme.md instructions the "project standard" of how to install and every other location should match or at least have a pointer that readme.md is the official set of instructions for installation.

An alternative strategy, which would probably annoy long term developers, would be to make the default branch in Github, I would assume, "release-1.5.x" instead of "develop" as probably the majority of people cloning the repo are just trying to make Docker install, not actually do development.

An alternative to the alternative is there may be a faster simpler lower bandwidth way to distribute a couple small docker-compose files than cloning the entire source code tree... maybe using git submodules would be the cleanest way to do this.

[Agnul97]

Thanks for the report and the provided solutions, I'll work on it

[Agnul97]

#3777