apache/apisix

docs: make route matching/filtering information more visible

Open

#10,735 opened on Dec 29, 2023

View on GitHub
 (4 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

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

Research direction
Examine the linked PR #10413 and the current router documentation to find a more visible way to present route matching information.
Tech stack
lua
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85