apache/apisix

docs: make route matching/filtering information more visible

Open

#10.735 aberto em 29 de dez. de 2023

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)Lua (16.597 stars) (2.860 forks)batch import
docgood first issue

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.

Guia do colaborador

Pilha de tecnologia
None
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
half day
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
needs maintainer response
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
needs investigation
Prerequisites
Understanding of Apache APISIX documentation structureFamiliarity with the router radixtree pageAbility to navigate GitHub discussions
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50
Direção de pesquisa
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.