docs: update prerequisites files with installation and connectivity t… #5094

DeeBi9 · 2025-01-18T19:13:07Z

What type of PR is this?
docs: update prerequisites and embed installation/testing steps

What this PR does / why we need it:
This PR updates the documentation by adding the installation guide and testing configuration steps from the quickstart guide to boilerplate prerequisites.md and o11y_prerequisites.md. The content is presented in a collapsible format and is a shorter version of the quickstart guide.

Which issue(s) this PR fixes:
#5064 (docs: Embed Quickstart Install steps in Tasks rather than link out)

Release Notes:
No

codecov · 2025-01-19T06:18:55Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.92%. Comparing base (549fdde) to head (a4835e1).
Report is 10 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5094      +/-   ##
==========================================
+ Coverage   66.86%   66.92%   +0.05%     
==========================================
  Files         210      210              
  Lines       32979    32979              
==========================================
+ Hits        22052    22071      +19     
+ Misses       9588     9574      -14     
+ Partials     1339     1334       -5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

arkodg · 2025-01-24T21:23:36Z

site/content/en/latest/boilerplates/o11y_prerequisites.md

+   helm install eg oci://docker.io/envoyproxy/gateway-helm --version {{< helm-version >}} -n envoy-gateway-system --create-namespace
+   ```
+
+   **Note**: Wait 2–5 minutes for the Envoy Gateway pod to reach the Running state.


can we rm this line ? 2-5 min sounds like a long time, and once helm completes, it should be okay to install the Quickstart right away (since CRDs have been installed)

Thanks for the feedback! I'll remove the line and update the PR accordingly.

arkodg · 2025-01-24T21:24:45Z

this looks good @DeeBi9 !
ptal @missBerg

…esting steps Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>

Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>

DeeBi9 · 2025-01-26T05:29:19Z

Hi @arkodg I noticed that the Check Links test case is failing because of an issue at line 939, where the URL https://jwt.io/ is returning a 500 Internal Server Error.

arkodg · 2025-01-28T00:14:29Z

Hi @arkodg I noticed that the Check Links test case is failing because of an issue at line 939, where the URL https://jwt.io/ is returning a 500 Internal Server Error.

yeah I think this was skipped in a newer commit, can you rebase and retry ?

arkodg · 2025-01-28T00:16:16Z

site/content/en/latest/boilerplates/o11y_prerequisites.md

@@ -1,8 +1,72 @@
 ---
 ---

-Follow the steps from the [Quickstart](../tasks/quickstart) to install Envoy Gateway and the example manifest.
-Before proceeding, you should be able to query the example backend using HTTP.
+Follow the steps below to install Envoy Gateway and the example manifest. Before


is it possible to dedup this / define it once in the below page ?

Hey @arkodg, just to clarify—are you suggesting that I should remove the install steps from o11y_prerequisites.md and instead reference prerequisites.md to avoid duplication?

Thanks

Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>

arkodg

LGTM thanks !

envoyproxy#5094) * docs: update prerequisites files with installation and connectivity testing steps Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> * lint Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> * docs: remove the Note Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> * remove redundant code Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> --------- Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>

envoyproxy#5094) * docs: update prerequisites files with installation and connectivity testing steps Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> * lint Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> * docs: remove the Note Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> * remove redundant code Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> --------- Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> (cherry picked from commit 3253339) Signed-off-by: Guy Daich <guy.daich@sap.com>

* doc: response compression (#5071) compression docs Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com> (cherry picked from commit 549fdde) Signed-off-by: Guy Daich <guy.daich@sap.com> * docs: how to specify a self-signed ca for the remote jwks host in the SP JWT settings. (#5085) * docs for jwt self-signed ca Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com> * fix gen Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com> * update docs Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com> --------- Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com> (cherry picked from commit fdc7849) Signed-off-by: Guy Daich <guy.daich@sap.com> * chore: fix gen (#5166) fix gen Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> (cherry picked from commit 34db8af) Signed-off-by: Guy Daich <guy.daich@sap.com> * docs: add api key auth instructions (#5097) * docs: add api key auth instruction Signed-off-by: Taufik Mulyana <nothinux@gmail.com> * fix: remove unrelated links Signed-off-by: Taufik Mulyana <nothinux@gmail.com> --------- Signed-off-by: Taufik Mulyana <nothinux@gmail.com> (cherry picked from commit b5cf087) Signed-off-by: Guy Daich <guy.daich@sap.com> * add SECURITY.md (#5167) Signed-off-by: Arko Dasgupta <arko@tetrate.io> (cherry picked from commit f7a10eb) Signed-off-by: Guy Daich <guy.daich@sap.com> * chore: link SECURITY.md (#5168) Signed-off-by: Arko Dasgupta <arko@tetrate.io> (cherry picked from commit ac9026f) Signed-off-by: Guy Daich <guy.daich@sap.com> * build(deps): bump actions/stale from 9.0.0 to 9.1.0 (#5162) Bumps [actions/stale](https://github.com/actions/stale) from 9.0.0 to 9.1.0. - [Release notes](https://github.com/actions/stale/releases) - [Changelog](https://github.com/actions/stale/blob/main/CHANGELOG.md) - [Commits](actions/stale@28ca103...5bef64f) --- updated-dependencies: - dependency-name: actions/stale dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Arko Dasgupta <arkodg@users.noreply.github.com> (cherry picked from commit 57d4aa8) Signed-off-by: Guy Daich <guy.daich@sap.com> * docs: rm sectionName from some of the examples (#5173) adds whats left off from #4868 deleted the sectionName in these examples because the Service spec does not define a port `Name` Signed-off-by: Arko Dasgupta <arko@tetrate.io> (cherry picked from commit 45804e2) Signed-off-by: Guy Daich <guy.daich@sap.com> * ci(fix): osv-scanner PR mode (#5174) fix: osv-scanner PR mode Signed-off-by: shahar-h <shahar.harari@sap.com> Co-authored-by: Guy Daich <guy.daich@sap.com> (cherry picked from commit e904d3f) Signed-off-by: Guy Daich <guy.daich@sap.com> * wip: docs: add standalone in container instruction (#5172) * docs: add standalone in container instruction Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com> * docs: update headings and image tag Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com> --------- Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com> (cherry picked from commit a3448c1) Signed-off-by: Guy Daich <guy.daich@sap.com> * docs: update prerequisites files with installation and connectivity t… (#5094) * docs: update prerequisites files with installation and connectivity testing steps Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> * lint Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> * docs: remove the Note Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> * remove redundant code Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> --------- Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> (cherry picked from commit 3253339) Signed-off-by: Guy Daich <guy.daich@sap.com> * [release/v1.3] fix 1.3.0-rc.1 release note (#5175) * fix 1.3.0-rc.1 release note Signed-off-by: Guy Daich <guy.daich@sap.com> * more fixes Signed-off-by: Guy Daich <guy.daich@sap.com> --------- Signed-off-by: Guy Daich <guy.daich@sap.com> (cherry picked from commit 4fba2bf) Signed-off-by: Guy Daich <guy.daich@sap.com> * fail validation if baseInterval is 0s (#5176) * fail validation if baseInterval is 0s Fixes: #5147 Signed-off-by: Arko Dasgupta <arko@tetrate.io> * more validations Signed-off-by: Arko Dasgupta <arko@tetrate.io> --------- Signed-off-by: Arko Dasgupta <arko@tetrate.io> (cherry picked from commit 4844d9a) Signed-off-by: Guy Daich <guy.daich@sap.com> * [release/1.3] release notes (#5177) Signed-off-by: Guy Daich <guy.daich@sap.com> (cherry picked from commit c2215b2) Signed-off-by: Guy Daich <guy.daich@sap.com> --------- Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com> Signed-off-by: Guy Daich <guy.daich@sap.com> Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> Signed-off-by: Taufik Mulyana <nothinux@gmail.com> Signed-off-by: Arko Dasgupta <arko@tetrate.io> Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: shahar-h <shahar.harari@sap.com> Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com> Signed-off-by: DeeBi9 <deepanshudb1@gmail.com> Co-authored-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> Co-authored-by: Taufik Mulyana <17433202+nothinux@users.noreply.github.com> Co-authored-by: Arko Dasgupta <arkodg@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: shahar-h <shahar.harari@sap.com> Co-authored-by: Denis Shatokhin <d_shatokhin@outlook.com> Co-authored-by: Deepanshu Bisht <113498676+DeeBi9@users.noreply.github.com>

DeeBi9 requested a review from a team as a code owner January 18, 2025 19:13

arkodg reviewed Jan 24, 2025

View reviewed changes

DeeBi9 added 3 commits January 25, 2025 10:39

docs: update prerequisites files with installation and connectivity t…

905d3f9

…esting steps Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>

lint

732201b

Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>

docs: remove the Note

f111ffb

Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>

DeeBi9 force-pushed the embed_quickstart_install_steps_in_tasks branch from b3d6e49 to f463e6f Compare January 25, 2025 05:30

arkodg reviewed Jan 28, 2025

View reviewed changes

remove redundant code

a4835e1

Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>

DeeBi9 force-pushed the embed_quickstart_install_steps_in_tasks branch from f8a47bc to a4835e1 Compare January 28, 2025 08:48

arkodg approved these changes Jan 30, 2025

View reviewed changes

arkodg requested review from a team January 30, 2025 02:17

arkodg added this to the v1.3.0 milestone Jan 30, 2025

guydc approved these changes Jan 30, 2025

View reviewed changes

arkodg merged commit 3253339 into envoyproxy:main Jan 30, 2025
27 of 28 checks passed

zirain mentioned this pull request Mar 25, 2025

docs: fix layout #5604

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: update prerequisites files with installation and connectivity t… #5094

docs: update prerequisites files with installation and connectivity t… #5094

Uh oh!

DeeBi9 commented Jan 18, 2025

Uh oh!

codecov bot commented Jan 19, 2025 •

edited

Loading

Uh oh!

arkodg Jan 24, 2025

Uh oh!

DeeBi9 Jan 25, 2025

Uh oh!

arkodg commented Jan 24, 2025

Uh oh!

DeeBi9 commented Jan 26, 2025 •

edited

Loading

Uh oh!

arkodg commented Jan 28, 2025

Uh oh!

arkodg Jan 28, 2025

Uh oh!

DeeBi9 Jan 28, 2025

Uh oh!

arkodg Jan 28, 2025

Uh oh!

arkodg left a comment

Uh oh!

Uh oh!

Uh oh!

docs: update prerequisites files with installation and connectivity t… #5094

docs: update prerequisites files with installation and connectivity t… #5094

Uh oh!

Conversation

DeeBi9 commented Jan 18, 2025

Uh oh!

codecov bot commented Jan 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

arkodg Jan 24, 2025

Choose a reason for hiding this comment

Uh oh!

DeeBi9 Jan 25, 2025

Choose a reason for hiding this comment

Uh oh!

arkodg commented Jan 24, 2025

Uh oh!

DeeBi9 commented Jan 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

arkodg commented Jan 28, 2025

Uh oh!

arkodg Jan 28, 2025

Choose a reason for hiding this comment

Uh oh!

DeeBi9 Jan 28, 2025

Choose a reason for hiding this comment

Uh oh!

arkodg Jan 28, 2025

Choose a reason for hiding this comment

Uh oh!

arkodg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Jan 19, 2025 •

edited

Loading

DeeBi9 commented Jan 26, 2025 •

edited

Loading