spring-cloud / spring-cloud/spring-cloud-netflix

Improve documentation on Eureka server setup

Open
#598 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Java
Stars
5k
Forks
2.5k
Avg merge
1d 2h
Merged PRs (30d)
10

Description

There were two things in the documentation that puzzled me:

  1. Seeing the Client docs first. You can't really get that to work without a server running, so I guess it'd make more sense from a narration point of view to start with the server docs.
  2. The server docs create the impression that the very first code sample is all you need as it concludes with: "The server has a home page with a UI, and HTTP API endpoints per the normal Eureka functionality under /eureka/*." Also, it feels a bit thrown together: "Example eureka server". "Eureka background reading:"

What if we started with an introductory paragraph that explains the modes of operation and then gives a quick start with what's needed for a single instance and then concludes with more elaborate discussion about why that's not a good idea in prod etc.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked server documentation and compare its placement with the Client documentation. Add introductory guidance on the operating modes, provide a single-instance quick start before the broader discussion, and clarify the production caveats and surrounding headings; done means the setup flow is understandable without the current ordering confusion.

Written by the indexing model from the issue text.

Assessment

Tech stack
spring
Domain
backend, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.