feat: add docs params to proxy and mesh resources #4132
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Proxy resources like `Dataplane`, `ZoneIngress` and `ZoneEgress`, as well as `Mesh` api resources are now marked with doc params, which will allow us to generate the reference docs automatically. Signed-off-by: Bart Smykla <bartek@smykla.com>
Signed-off-by: Bart Smykla <bartek@smykla.com>
Signed-off-by: Bart Smykla <bartek@smykla.com>
Signed-off-by: Bart Smykla <bartek@smykla.com>
lahabana
reviewed
Apr 6, 2022
Signed-off-by: Bart Smykla <bartek@smykla.com>
Signed-off-by: Bart Smykla <bartek@smykla.com>
…neration-params-to-proxies-and-mesh
jakubdyszkiewicz
approved these changes
Apr 7, 2022
…neration-params-to-proxies-and-mesh
Signed-off-by: Bart Smykla <bartek@smykla.com>
SallyBlichWalkMe
pushed a commit
to SallyBlichWalkMe/kuma
that referenced
this pull request
Apr 20, 2022
* feat: add docs params to proxy and mesh resources Proxy resources like `Dataplane`, `ZoneIngress` and `ZoneEgress`, as well as `Mesh` api resources are now marked with doc params, which will allow us to generate the reference docs automatically. Signed-off-by: Bart Smykla <bartek@smykla.com>
SallyBlichWalkMe
pushed a commit
to SallyBlichWalkMe/kuma
that referenced
this pull request
Apr 21, 2022
* feat: add docs params to proxy and mesh resources Proxy resources like `Dataplane`, `ZoneIngress` and `ZoneEgress`, as well as `Mesh` api resources are now marked with doc params, which will allow us to generate the reference docs automatically. Signed-off-by: Bart Smykla <bartek@smykla.com>
SallyBlichWalkMe
pushed a commit
to SallyBlichWalkMe/kuma
that referenced
this pull request
Apr 21, 2022
* feat: add docs params to proxy and mesh resources Proxy resources like `Dataplane`, `ZoneIngress` and `ZoneEgress`, as well as `Mesh` api resources are now marked with doc params, which will allow us to generate the reference docs automatically. Signed-off-by: Bart Smykla <bartek@smykla.com> Signed-off-by: Sally Blich <sally.blich@walkme.com>
SallyBlichWalkMe
pushed a commit
to SallyBlichWalkMe/kuma
that referenced
this pull request
Apr 21, 2022
* feat: add docs params to proxy and mesh resources Proxy resources like `Dataplane`, `ZoneIngress` and `ZoneEgress`, as well as `Mesh` api resources are now marked with doc params, which will allow us to generate the reference docs automatically. Signed-off-by: Bart Smykla <bartek@smykla.com> Signed-off-by: Sally Blich <sally.blich@walkme.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Proxy resources like
Dataplane,ZoneIngressandZoneEgress,as well as
Meshapi resources are now marked with doc params,which will allow us to generate the reference docs automatically.
Blocked by: kumahq/protoc-gen-kumadoc#8 and pushing
0.2.0tag forprotoc-gen-kumadocafter the PR will be mergedFull changelog
n/a
Issues resolved
n/a
Documentation
n/a
Testing
Backwards compatibility
UPGRADE.mdwith any steps users will need to take when upgrading.backport-to-stablelabel if the code follows our backporting policy