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

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

Open
2 tasks
jkonicki opened this issue Sep 23, 2021 · 7 comments
Open
2 tasks
Assignees
Labels
getting-started-guide Anything related to the getting started guides good first issue Good for newcomers Hacktoberfest Hacktoberfest label help wanted Extra attention is needed

Comments

@jkonicki
Copy link
Contributor

jkonicki commented Sep 23, 2021

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

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

@jkonicki jkonicki added help wanted Extra attention is needed good first issue Good for newcomers getting-started-guide Anything related to the getting started guides Hacktoberfest Hacktoberfest label labels Sep 23, 2021
@ZuraizAhmedShehzad
Copy link
Contributor

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

@jkonicki
Copy link
Contributor Author

jkonicki commented Apr 5, 2023

@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
Copy link
Contributor

@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
Copy link
Contributor Author

jkonicki commented Apr 5, 2023

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

@ZuraizAhmedShehzad
Copy link
Contributor

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

@TimHess
Copy link
Member

TimHess commented Apr 5, 2023

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
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
getting-started-guide Anything related to the getting started guides good first issue Good for newcomers Hacktoberfest Hacktoberfest label help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants