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.

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

docs: replaces json patch bodies with yaml format #3184

Merged
merged 4 commits into from
Apr 19, 2024

Conversation

eitansuez
Copy link
Contributor

@eitansuez eitansuez commented Apr 12, 2024

What type of PR is this?

  • docs: replaces kubectl patch with json bodies to yaml, for better legibility

What this PR does / why we need it:

improves the docs.

Which issue(s) this PR fixes:

Fixes #3180

@eitansuez eitansuez requested a review from a team as a code owner April 12, 2024 19:01
@zirain zirain changed the title docs: replaces json patch bodies with yaml format (#3180) docs: replaces json patch bodies with yaml format Apr 13, 2024
@@ -29,7 +29,7 @@ Create a certificate and a private key for `www.example.com`:

```shell
openssl req -out www.example.com.csr -newkey rsa:2048 -nodes -keyout www.example.com.key -subj "/CN=www.example.com/O=example organization"
openssl x509 -req -days 365 -CA example.com.crt -CAkey example.com.key -set_serial 0 -in www.example.com.csr -out www.example.com.crt
openssl x509 -req -days 365 -CA ca.crt -CAkey ca.key -set_serial 0 -in www.example.com.csr -out www.example.com.crt
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above

@eitansuez
Copy link
Contributor Author

/retest

@@ -5,6 +5,7 @@ title: "Gateway Address"
The Gateway API provides an optional [Addresses][] field through which Envoy Gateway can set addresses for Envoy Proxy Service.
Depending on the Service Type, the addresses of gateway can be used as:

- [Prerequisites](#prerequisites)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need this in this context?


## Prerequisites

- OpenSSL to generate TLS assets.

## Installation

Follow the steps from the [Quickstart](../../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../quickstart) to install Envoy Gateway and the example manifest.
Copy link
Contributor

@shawnh2 shawnh2 Apr 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this link should not be changed, it will lead to 404 pages

@@ -5,6 +5,7 @@ title: "Gateway Address"
The Gateway API provides an optional [Addresses][] field through which Envoy Gateway can set addresses for Envoy Proxy Service.
Depending on the Service Type, the addresses of gateway can be used as:

- [Prerequisites](#prerequisites)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

Copy link
Contributor

@shawnh2 shawnh2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the amazing work! just add few comments

@eitansuez
Copy link
Contributor Author

/retest

Eitan Suez added 4 commits April 17, 2024 09:26
Signed-off-by: Eitan Suez <eitan@tetrate.io>
Signed-off-by: Eitan Suez <eitan@tetrate.io>
Signed-off-by: Eitan Suez <eitan@tetrate.io>
@eitansuez
Copy link
Contributor Author

i believe i have resolved all issues raised. if possible, please review and resolve those conversations. thanks.

Copy link
Contributor

@arkodg arkodg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks !

@arkodg arkodg requested review from a team, zirain and shawnh2 April 18, 2024 20:45
Copy link
Contributor

@shawnh2 shawnh2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@arkodg arkodg merged commit 9d5c2d8 into envoyproxy:main Apr 19, 2024
20 checks passed
@eitansuez eitansuez deleted the docs-patch-yaml branch April 19, 2024 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: make kubectl patch commands use yaml instead of json payloads, for legibility
4 participants