Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Manifest based documentaton extensions #11085

Closed
htuch opened this issue May 6, 2020 · 0 comments · Fixed by #11364
Closed

Manifest based documentaton extensions #11085

htuch opened this issue May 6, 2020 · 0 comments · Fixed by #11364
Assignees
@htuch
Labels
area/docs no stalebot Disables stalebot from closing an issue

Comments

@htuch
Copy link
Member

htuch commented May 6, 2020

As per #11058 (comment), it would be ideal to be able to augment API field documentation with things such as:

  • Proxy specific implementation status (i.e. whether a feature is implemented in Envoy yet, whether it's alpha or stable)
  • OOB data such as example secure configurations (which may also be proxy specific).

The solution is to have a proxy manifest file that acts as a map from API field to additional information. This will be glued by protodoc (for Envoy at least) in to the final end user docs.
@htuch htuch self-assigned this May 6, 2020
@htuch htuch added the area/docs label May 6, 2020
This was referenced May 6, 2020
Merged
Closed
@mattklein123 mattklein123 added the no stalebot Disables stalebot from closing an issue label May 6, 2020
htuch added a commit to htuch/envoy that referenced this issue May 7, 2020
@htuch
api: drop_overload is not yet implemented in Envoy.
e8c0bb1 
This was added before we started annotating fields missing
implementations. Fixed with a [#not-implemented-hide:] annotations for
now, the plan is to move things like this to
envoyproxy#11085 when it lands.

Signed-off-by: Harvey Tuch <htuch@google.com>
@htuch htuch mentioned this issue May 7, 2020
Merged
htuch added a commit that referenced this issue May 7, 2020
@htuch
api: drop_overload is not yet implemented in Envoy. (#11104)
a250a87 
This was added before we started annotating fields missing
implementations. Fixed with a [#not-implemented-hide:] annotations for
now, the plan is to move things like this to
#11085 when it lands.

Signed-off-by: Harvey Tuch <htuch@google.com>
mattklein123 pushed a commit to envoyproxy/data-plane-api that referenced this issue May 7, 2020
api: drop_overload is not yet implemented in Envoy. (#11104)
acb13b6 
This was added before we started annotating fields missing
implementations. Fixed with a [#not-implemented-hide:] annotations for
now, the plan is to move things like this to
envoyproxy/envoy#11085 when it lands.

Signed-off-by: Harvey Tuch <htuch@google.com>

Mirrored from https://github.com/envoyproxy/envoy @ a250a871571f18dffd13732da83cbd4a677b1f03
htuch added a commit to htuch/envoy that referenced this issue May 7, 2020
@htuch
build: add support for pip3_import from rules_python.
bda0b62 
Provide an Envoy build system styled way of loading arbitrary pip3
packages as py_{library,binary} dependencies.

Part of envoyproxy#11085 (to fetch
PyYAML).

Risk level: Low (build system)
Testing: Manual validation that the test utility loads PyYAML at the
  correct version (different to my system version).

Signed-off-by: Harvey Tuch <htuch@google.com>
@htuch htuch mentioned this issue May 7, 2020
Merged
lizan pushed a commit that referenced this issue May 12, 2020
@htuch
build: add support for pip3_import from rules_python. (#11108)
568e139 
Provide an Envoy build system styled way of loading arbitrary pip3
packages as py_{library,binary} dependencies.

Part of #11085 (to fetch
PyYAML).

Risk level: Low (build system)
Testing: Manual validation that the test utility loads PyYAML at the
  correct version (different to my system version).

Signed-off-by: Harvey Tuch <htuch@google.com>
htuch added a commit to htuch/envoy that referenced this issue May 29, 2020
@htuch
api: populate secure edge defaults manifest.
6aab651 
Adding API annotations and manifest entries to match https://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/edge#best-practices-edge.

Risk level: Low (API/docs only change)
Testing: Docs build and inspection.

Fixes envoyproxy#11085

Signed-off-by: Harvey Tuch <htuch@google.com>
@htuch htuch mentioned this issue May 29, 2020
Merged
htuch added a commit that referenced this issue Jun 9, 2020
@htuch
api: populate secure edge defaults manifest. (#11364)
f5753e5 
Adding API annotations and manifest entries to match https://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/edge#best-practices-edge.

Risk level: Low (API/docs only change)
Testing: Docs build and inspection.

Fixes #11085

Signed-off-by: Harvey Tuch <htuch@google.com>
songhu pushed a commit to songhu/envoy that referenced this issue Jun 25, 2020
@htuch @songhu
api: populate secure edge defaults manifest. (envoyproxy#11364)
8d89892 
Adding API annotations and manifest entries to match https://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/edge#best-practices-edge.

Risk level: Low (API/docs only change)
Testing: Docs build and inspection.

Fixes envoyproxy#11085

Signed-off-by: Harvey Tuch <htuch@google.com>
yashwant121 pushed a commit to yashwant121/envoy that referenced this issue Jul 24, 2020
@htuch @yashwant121
api: populate secure edge defaults manifest. (envoyproxy#11364)
ac0f2b8 
Adding API annotations and manifest entries to match https://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/edge#best-practices-edge.

Risk level: Low (API/docs only change)
Testing: Docs build and inspection.

Fixes envoyproxy#11085

Signed-off-by: Harvey Tuch <htuch@google.com>
Signed-off-by: yashwant121 <yadavyashwant36@gmail.com>
@htuch htuch mentioned this issue May 12, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@htuch htuch

Labels
area/docs no stalebot Disables stalebot from closing an issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

api: populate secure edge defaults manifest. htuch/envoy
2 participants
@mattklein123 @htuch