apache/apisix

docs: make route matching/filtering information more visible

Open

#10.735 geöffnet am 29. Dez. 2023

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Lua (16.597 Stars) (2.860 Forks)batch import
docgood first issue

Beschreibung

Current State

Route matching related information is given here: https://apisix.apache.org/docs/apisix/router-radixtree/ but the page that contains this information is not much visible.

Desired State

To fix this I raised this PR: https://github.com/apache/apisix/pull/10413, but it didn't seem like a good solution. Anyone interested can take a look at the conversation to find a better way to address this problem.

Contributor Guide

Tech Stack
Keine
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
needs maintainer response
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
needs investigation
Voraussetzungen
Understanding of Apache APISIX documentation structureFamiliarity with the router radixtree pageAbility to navigate GitHub discussions
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50
Research-Richtung
Review the conversation in the linked PR #10413 to understand why the previous solution was not accepted. Identify alternative ways to make the route matching information more visible, such as adding a prominent link on the documentation's sidebar or index page. Consider consulting maintainers for preferred approaches or acceptable modifications to the documentation layout.