envoyproxy/envoy

Add a sphinx plugin to allow linking from demo configurations to api sections

Open

#15,332 建立於 2021年3月5日

在 GitHub 查看
 (6 留言) (0 反應) (1 負責人)C++ (5,373 fork)batch import
area/docshelp wanted

倉庫指標

Star
 (27,997 star)
PR 合併指標
 (平均合併 8天) (30 天內合併 378 個 PR)

描述

description

learning envoy configuration can be quite a steep learning curve and its not always easy to navigate the docs to find the relevant spec

im thinking it might be helpful if the config examples in the docs provided a click through to the relevant api section - perhaps if you hover over the line a link appears at the end, for example

depending on how fine grained the links were, i think we might need to add more ref links in the api to allow that

on a related point im noticing that all most of the api examples are json - whereas the config examples are mostly yaml. There are probably good reasons for both, but im thinking this is another way in which the docs can jar for new users.

貢獻者指南