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

Slight cleanup of some of our readmes #221

Merged
merged 6 commits into from
Jan 27, 2025

Conversation

kfswain
Copy link
Collaborator

@kfswain kfswain commented Jan 23, 2025

Part of #202

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kfswain

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 23, 2025
Copy link

netlify bot commented Jan 23, 2025

Deploy Preview for gateway-api-inference-extension ready!

Name Link
🔨 Latest commit 86ad1e5
🔍 Latest deploy log https://app.netlify.com/sites/gateway-api-inference-extension/deploys/6797e93cd48a4400082dd98b
😎 Deploy Preview https://deploy-preview-221--gateway-api-inference-extension.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ahg-g
Copy link
Contributor

ahg-g commented Jan 24, 2025

Is this part of #202?

Copy link
Contributor

@danehans danehans left a comment

Choose a reason for hiding this comment

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

To provide clear separation between the Gateway implementation and the extension, est_proc.yaml should be in a separate directory, e.g. ./pkg/manifests/epp, ./pkg/manifests/inference-extension, etc. (xref)

@danehans
Copy link
Contributor

Is this part of #202?

If so, please add Fixes: <Issue #>

pkg/README.md Outdated
1. **Install the CRDs into the cluster:**

```sh
make install
Copy link
Contributor

Choose a reason for hiding this comment

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

Considering using kubectl apply -f config/crd/bases for consistency and some no-dev users are more likely to have kubectl installed than make.

Copy link
Contributor

Choose a reason for hiding this comment

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

+1, this will point to a released manifest once we release

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added a second option for the user to pick

Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, I am wondering if we can have the guide to not require cloning the repo? This significantly reduces the barrier to testing it out.

All the kubectl commands can be run against the files from github directly.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 25, 2025
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 27, 2025
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 27, 2025

Unverified

This user has not yet uploaded their public signing key.

Unverified

This user has not yet uploaded their public signing key.
pkg/README.md Outdated
1. **Install the CRDs into the cluster:**

```sh
make install
Copy link
Contributor

Choose a reason for hiding this comment

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

+1, this will point to a released manifest once we release

@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 27, 2025
@ahg-g
Copy link
Contributor

ahg-g commented Jan 27, 2025

once this merges, we will have the manifests in the right places and we can update the kubectl commands to point to github directly so that we don't require cloning the repo to run the guide.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 27, 2025
@k8s-ci-robot k8s-ci-robot merged commit 86178fb into kubernetes-sigs:main Jan 27, 2025
8 checks passed
@kfswain kfswain mentioned this pull request Jan 28, 2025
@kfswain kfswain deleted the doc-updates branch February 10, 2025 22:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants