search

spring-cloud / spring-cloud-cli

Spring Cloud CLI features
Apache License 2.0
155 stars 80 forks source link

Spring cloud cli documentation improvements for beginners. #178

Open XI1998-swapnilmarathe opened 2 years ago

XI1998-swapnilmarathe commented 2 years ago

Hello,

Thank you for creating such an amazing tool.

I would like to suggest some improvements to the documentation. Kindly consider that I do not have any prior experience to spring boot cli or spring boot cloud cli.

  1. No link provided on how to install Spring boot CLI if not present already. If we see it points to github page of spring boot which in turn is not very informative about the boot cli tool.
image
  1. Post following SDKMan steps, It says image

Now, I am not sure in which folder I should do mvn install. From what I understood from the description.

With the Launcher CLI you can launch services like Eureka, Zipkin, Config Server conveniently all at once from the command line (very useful at development time).

So I thought that this cli works regardless of you are inside a spring boot project with sensible defaults for each component like kafka, eureka and so on. Maybe I am not having clear understanding.

  1. I think it has some compatibility matrix for JDK and so on as I faced one error.

    image

  2. We should suggest what is difference between spring boot cli and spring boot cloud cli as well.

  3. Not sure where I can find latest version of both tools and does it map to spring boot version 1-1? So I can assume safely that for each spring boot release version, cli gets released, I can just safely use that version and install it.

  4. If I want to create newer project can I upgrade cli?

Hope it helps.

gonmmarques commented 2 years ago

@XI1998-swapnilmarathe not sure if you still have doubts, but maybe this can also help you https://medium.com/@goncalo.m.marques/how-to-take-advantage-of-spring-boot-cloud-cli-de21a54bcf8b