Testing and validation of Getting started guides for Service Discovery

SteeltoeOSS / Documentation

The documentation, api browser, and getting started guides used for the Steeltoe's website.

Apache License 2.0

8 stars 23 forks source link

Testing and validation of Getting started guides for Service Discovery #229

Open jkonicki opened 3 years ago

jkonicki commented 3 years ago

We are looking for users to run through our Service Discovery getting started guide.

[ ] Eureka Service Discovery
[ ] Consul Service Discovery

Please validate the guide above, create any issues, create a PR (if you can), and leave a comment about the work you completed.

Here is the directory listing for the guide markdown

ZuraizAhmedShehzad commented 1 year ago

@jkonicki Hi, I am looking into this issue as my first issue. Can you further explain?

jkonicki commented 1 year ago

@ZuraizAhmedShehzad The goal is have someone run through these two project guides on the Steeltoe website (as noted above for Eureka and Consul) to ensure they cover all aspects of setting up and working with these services. If you find any issues with them, to note them, and even better, create a PR that updates the guide.

ZuraizAhmedShehzad commented 1 year ago

@jkonicki I managed to setup "Service Discovery with Eureka Server". I want to share some findings with you.

API Projects 'Register' and 'Discover' scaffolded by Steeltoe Initializr doesn't have Values controller by default while documentation is giving such perception that its already there and user just has to tweak code within it "Change the values controller to make a request to the discovery service and return the result in contollers\ValuesController.cs" that seemed a bit ambiguous.
Same is the case for configuration.

We can add much more clarity for user by asking him to add configurations and create controller on his own if Steeltoe Initializr is not scaffolding it for them.

jkonicki commented 1 year ago

Thank you @ZuraizAhmedShehzad I am adding @TimHess to take over this issue.

ZuraizAhmedShehzad commented 1 year ago

@jkonicki okay. I can create PR if my points stay valid.

TimHess commented 1 year ago

I think it might be better to update the guide to use the weatherforecast model and controller that are included with the templates rather than adding instructions around adding a ValuesController (I think that's from an older .NET project template).

Are you talking about the IIS configuration? I think that was removed from Initializr... I'd be inclined to update this guide to use the current settings coming out of the Initializr (running the project directly) and that way we also avoid the need for IIS Express and get a cleaner implementation with less that can get in the way.

ZuraizAhmedShehzad commented 1 year ago

@TimHess Perfect ! I will create a PR the way you have mentioned.