apache/apisix

docs: Rework the service discovery documentation in general and Eureka in particular

Open

#7,342 opened on Jun 28, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Lua (2,860 forks)batch import
docgood first issue

Repository metrics

Stars
 (16,597 stars)
PR merge metrics
 (Avg merge 7d 18h) (97 merged PRs in 30d)

Description

Current State

The Integration service discovery registry mentions service discovery and how you can potentially create your own mechanism. It uses the example for Eureka.

After discussing with @bzp2010, it seems there's no need to create Eureka as it's part of the out-of-the-box features.

Desired State

We shall:

  • Document how to use Eureka as a service discovery provider
  • Design a new example on how to implement one custom service discovery provider

Contributor guide

Research direction
Review the existing integration service discovery documentation at https://apisix.apache.org/docs/apisix/discovery/. Examine the current Eureka example and the discussion with @bzp2010 in the issue comments. Determine how to restructure the docs to clearly show Eureka as built in and create a new example for implementing a custom provider.
Tech stack
None
Domain
documentationbackenddevops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
APISIX service discoveryEureka basicsDocumentation writing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45