-
Notifications
You must be signed in to change notification settings - Fork 168
Docs: Versions the quickstart guide #1604
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Daneyon Hansen <[email protected]>
✅ Deploy Preview for gateway-api-inference-extension ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: danehans The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
If others prefer, I can update the dependency section to set |
mmm. I think we should be able to test main in a very easy and straight forward way. having said the above, not going to insist on it if others think otherwise :) |
IMHO main is tested with e2e tests. If we need to test different gateway implementations, then let's update the e2e's to include currently supported gateways. As for manualy testing main, e.g. quickstart doc, we should keep separate steps in the /docs dir where other dev docs exist. This can be temporary until we support multi-version docs (#422).
The current approach has been fragile and the quickstart is meant to be user facing whereas working on main is dev-facing. We need a stable versioned quickstart, especially now that the project is v1.0.0. As an alternative, I'm in favor of scaling back the quickstart to only installing GIE CRDs and the EPP Helm chart then linking to the conformance page for install/uninstall gateway-specific steps. |
Note: If the quickstart is versioned, the following steps should be completed:
|
Sorry, I'm not up to date. Why would we need to cut a new release? |
This PR pins the quickstart to the v1.0.0 release. This is needed to provide stability to the quickstart guide until #422 is fixed. Note that #1494 tracks the need to update the release script to manage versioning.
What type of PR is this?
Add one of the following kinds:
/kind bug
/kind documentation
What this PR does / why we need it:
Which issue(s) this PR fixes:
N/A
Does this PR introduce a user-facing change?: