apache/apisix

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

Offen

#7.342 geöffnet am 28.06.2022

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Lua (2.860 Forks)batch import
docgood first issue

Repository-Metriken

Stars
 (16.597 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Überprüfen Sie die aktuelle Service Discovery Dokumentation und den Eureka Integrationscode, dokumentieren Sie dann, wie Eureka als Service Discovery Anbieter verwendet wird, und entwerfen Sie ein neues Beispiel zur Implementierung eines benutzerdefinierten Service Discovery Anbieters.
Tech Stack
lua
Domain
backendapi
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitAPISIX basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65