envoyproxy/envoy

Extension matcher documentation doesn't generate a link to the xds Matcher type

Open

#18.154 aperta il 17 set 2021

Vedi su GitHub
 (5 commenti) (0 reazioni) (1 assegnatario)C++ (5373 fork)batch import
area/docsbughelp wantedno stalebot

Metriche repository

Star
 (27.997 star)
Metriche merge PR
 (Merge medio 8g) (378 PR mergiate in 30 g)

Descrizione

Title: Extension matcher documentation doesn't generate a link to the xds Matcher type

Description:

In the extension matcher docs, the documentation generator doesn't generate a reference link for the xds.type.matcher.v3.Matcher.

The actual sphinx doc looks like this. Note How there is no :ref: generated for the xds.type.matcher.v3.Matcher type:

.. code-block:: json

  {
    "matcher": "{...}",
    "xds_matcher": "{...}",
    "extension_config": "{...}"
  }

.. _envoy_v3_api_field_extensions.common.matching.v3.ExtensionWithMatcher.matcher:

matcher
  (:ref:`config.common.matcher.v3.Matcher <envoy_v3_api_msg_config.common.matcher.v3.Matcher>`) The associated matcher. This is deprecated in favor of xds_matcher.
  
  
.. _envoy_v3_api_field_extensions.common.matching.v3.ExtensionWithMatcher.xds_matcher:

xds_matcher
  (.xds.type.matcher.v3.Matcher) The associated matcher.
  
  
.. _envoy_v3_api_field_extensions.common.matching.v3.ExtensionWithMatcher.extension_config:

extension_config
  (:ref:`config.core.v3.TypedExtensionConfig <envoy_v3_api_msg_config.core.v3.TypedExtensionConfig>`, *REQUIRED*) The underlying extension config.

Guida contributor

Direzione di ricerca
Il problema consiste nell'aggiungere un collegamento Sphinx `:ref:` per il tipo `xds.type.matcher.v3.Matcher` nella documentazione dell'estensione matcher. I file probabilmente si trovano nella directory api/envoy/... . Esaminare lo schema utilizzato per altri campi (ad esempio `config.common.matcher.v3.Matcher`) e replicarlo per `xds matcher`. Assicurarsi che il target di riferimento esista. La documentazione attuale mostra un collegamento mancante; aggiungere un riferimento incrociato.
Tech stack
python
Dominio
documentationdeveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitDocumentation generation tools (Sphinx)
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85