docs: add cncf/xds protos #20277
docs: add cncf/xds protos #20277
Conversation
Signed-off-by: Kuat Yessenov <kuat@google.com>
|
docs build is currently failing with /tmp/tmpi0b_qhq4/generated/rst/api-v3/common_messages/common_messages.rst:4: WARNING: toctree contains reference to nonexisting document 'cncf/type/v3/range.proto'
/tmp/tmpi0b_qhq4/generated/rst/api-v3/common_messages/common_messages.rst:4: WARNING: toctree contains reference to nonexisting document 'cncf/type/matcher/v3/range.proto'
/tmp/tmpi0b_qhq4/generated/rst/cncf/core/v3/collection_entry.proto.rst:24: WARNING: Definition list ends without a blank line; unexpected unindent.
/tmp/tmpi0b_qhq4/generated/rst/cncf/core/v3/collection_entry.proto.rst:72: ERROR: Unknown target name: "a-za-z0-9".
/tmp/tmpi0b_qhq4/generated/rst/cncf/core/v3/context_params.proto.rst:23: ERROR: Unexpected indentation.
/tmp/tmpi0b_qhq4/generated/rst/cncf/type/v3/typed_struct.proto.rst:26: ERROR: Unexpected indentation.
/tmp/tmpi0b_qhq4/generated/rst/cncf/type/v3/typed_struct.proto.rst:27: WARNING: Block quote ends without a blank line; unexpected unindent.
when the build succeeds - it will be rendered here: https://storage.googleapis.com/envoy-pr/20277/docs/index.html |
|
@phlax I tested locally with cncf/xds#32 and it passes. Waiting for upstream to merge it so that I can bump the dependency. |
Signed-off-by: Kuat Yessenov <kuat@google.com>
repokitteh-read-only
bot
added
the
deps
|
CC @envoyproxy/dependency-shepherds: Your approval is needed for changes made to |
Signed-off-by: Kuat Yessenov <kuat@google.com>
Signed-off-by: Kuat Yessenov <kuat@google.com>
Signed-off-by: Kuat Yessenov <kuat@google.com>
|
CC @envoyproxy/api-shepherds: Your approval is needed for changes made to |
Signed-off-by: Kuat Yessenov <kuat@google.com>
|
API council: There is an interesting problem with protos defined in cncf/xds but which are implemented in envoy. Envoy outputs extension documentation using the proto as canonical extension page. I think we need an alternative way, with an extension page referencing its external proto. For now, I'm going to explicitly enumerate them (it's just trie matcher) because it's hard to trigger protodoc without proto input. |
|
/retest |
|
Retrying Azure Pipelines: |
| @@ -20,7 +21,7 @@ envoy_cc_library( | |||
| ], | |||
| ) | |||
|
|
|||
| envoy_cc_library( | |||
| envoy_cc_extension( | |||
There was a problem hiding this comment.
Do you really need to change this just for docs?
There was a problem hiding this comment.
It's really an extension. It's main difference is that its proto is in cncf/xds.
There was a problem hiding this comment.
I wonder if some of these extensions in common really should have been in extensions/, but might be a bit late for that
There was a problem hiding this comment.
These are core extensions probably so it's a bit blurry.
Signed-off-by: Kuat Yessenov <kuat@google.com>
|
Any more thoughts? This is needed for #20110. |
|
/retest |
|
Retrying Azure Pipelines: |
|
/retest |
|
Retrying Azure Pipelines: |
|
Not sure what the next step should be here - awaiting for review. |
|
@kyessenov looking at the docs im noticing that its using the proto path for titles - eg im wondering if we could/should make this more like |
|
@phlax Right, that's because there is no protodoc title in those protos. We can make a better fallback, "XDS: authority.proto" I think, if you think that's better. |
|
yep - altho for consistency i would go with iiuc that means we will need to update upstream - so i guess not a blocker to landing this PR |
|
Yeah we will need an upstream PR. I have a couple of changes not merged in upstream, so would prefer not block. |
phlax
removed
the
deps
|
Thanks @kyessenov this is an amazing addition and will really go a long way to helping end users. Thank you so much and amazing work! |
Signed-off-by: Kuat Yessenov <kuat@google.com>
Signed-off-by: Kuat Yessenov kuat@google.com
Commit Message: Generate docs for cncf/xds and include them in Envoy documentation
Additional Description: Requires cncf/xds#32.
Risk Level: low
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
Fixes cncf/xds#29
/assign @phlax