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: update prerequisites files with installation and connectivity t… #5094

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

DeeBi9
Copy link
Contributor

@DeeBi9 DeeBi9 commented Jan 18, 2025

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

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

codecov bot commented Jan 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.86%. Comparing base (a1e2022) to head (f463e6f).
Report is 35 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5094      +/-   ##
==========================================
+ Coverage   66.80%   66.86%   +0.06%     
==========================================
  Files         210      210              
  Lines       32953    32953              
==========================================
+ Hits        22013    22035      +22     
+ Misses       9603     9585      -18     
+ Partials     1337     1333       -4     

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

Signed-off-by: DeeBi9 <[email protected]>
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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

@arkodg
Copy link
Contributor

arkodg commented Jan 24, 2025

this looks good @DeeBi9 !
ptal @missBerg

@DeeBi9 DeeBi9 force-pushed the embed_quickstart_install_steps_in_tasks branch from b3d6e49 to f463e6f Compare January 25, 2025 05:30
@DeeBi9
Copy link
Contributor Author

DeeBi9 commented Jan 26, 2025

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.

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.

2 participants