Skip to content

Commit

Permalink
update readme references to kgateway (#56)
Browse files Browse the repository at this point in the history
* update readme references

* casing
  • Loading branch information
jenshu authored Jan 17, 2025
1 parent 2251e14 commit d3f039c
Show file tree
Hide file tree
Showing 9 changed files with 47 additions and 47 deletions.
10 changes: 5 additions & 5 deletions CHARTER.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# K8sGateway Charter
# Kgateway Charter

## Mission

The K8sGateway project strives to provide the best API Gateway for Kubernetes.
The kgateway project strives to provide the best API Gateway for Kubernetes.

## Scope

K8sGateway is a control plane and data plane built for Kubernetes which implements the Kubernetes Gateway API standard for traffic routing. Deployment of the control plane on other platforms is not tested, nor supported in any way by the K8sGateway community but our gateway can handle traffic for a wide variety of destination platforms. Our core focus is on building a reliable, performant control plane with limited extensions to our shipped Envoy proxy data plane.
Kgateway is a control plane and data plane built for Kubernetes which implements the Kubernetes Gateway API standard for traffic routing. Deployment of the control plane on other platforms is not tested, nor supported in any way by the kgateway community but our gateway can handle traffic for a wide variety of destination platforms. Our core focus is on building a reliable, performant control plane with limited extensions to our shipped Envoy proxy data plane.

## Values

### Inclusive

K8sGateway was initially created by a capable group of engineers with deep experience building proven control planes and proxies but without diverse input this project can never be at its best. We strive to build an inclusive community where all good-faith input is appreciated and diverse opinions and contributions are welcomed.
Kgateway was initially created by a capable group of engineers with deep experience building proven control planes and proxies but without diverse input this project can never be at its best. We strive to build an inclusive community where all good-faith input is appreciated and diverse opinions and contributions are welcomed.

### Merit

We weigh contributions based on their merits, not based on their source. We recognize that finding time for open source contributions can be challenging and appreciate the time and effort our contributors put into their work.

### Open

K8sGateway is open source. We believe through combined efforts, shared experience and the strength of open community we can build a better API Gateway.
Kgateway is open source. We believe through combined efforts, shared experience and the strength of open community we can build a better API Gateway.
4 changes: 2 additions & 2 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# K8sGateway Community Code of Conduct
# Kgateway Community Code of Conduct

All members of the K8sGateway community must abide by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
All members of the kgateway community must abide by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
Only by respecting one another can we build a strong and collaborative community.

22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to K8sGateway
# Contributing to kgateway

Excited about K8sGateway and want to help make it better?
Excited about kgateway and want to help make it better?

Here are some of the ways you can contribute:

Expand All @@ -19,9 +19,9 @@ To understand contributor roles, refer to the [contributor ladder guide](CONTRIB

## Requirements for PRs

Contributing to open source can be a daunting task, especially if you are a new contributor and are not yet familiar with the workflows commonly used by open source projects. K8sGateway uses a "fork and pull request" approach. This means that contributors will typically create their own personal fork of a code repository in GitHub and push their contributions to a branch in their own fork first. Once they are ready to contribute they can open a pull request (PR) against the project's repository which will be reviewed by the project. Reviews will typically include iterations of suggestions and changes. This is totally normal, don't be discouraged if asked to make changes to your contribution.
Contributing to open source can be a daunting task, especially if you are a new contributor and are not yet familiar with the workflows commonly used by open source projects. Kgateway uses a "fork and pull request" approach. This means that contributors will typically create their own personal fork of a code repository in GitHub and push their contributions to a branch in their own fork first. Once they are ready to contribute they can open a pull request (PR) against the project's repository which will be reviewed by the project. Reviews will typically include iterations of suggestions and changes. This is totally normal, don't be discouraged if asked to make changes to your contribution.

It's difficult to cover all possible scenarios you may encounter when contributing to open source software in a document however there are a few requirements explained below which even some well versed contributors may not be familiar with. If you have questions, concerns or just need help getting started please don't hesitate to reach out. We are available in our CNCF slack channel, #k8sgateway, or you can join the community meeting to meet folks and ask for help there. We'd love to hear from you and help get your started on your open source journey. Links are available below in the [Big pull requests](#big-prs) section<!-- TODO: fix this, see the section on big PRs for contact details isn't great -->.
It's difficult to cover all possible scenarios you may encounter when contributing to open source software in a document however there are a few requirements explained below which even some well versed contributors may not be familiar with. If you have questions, concerns or just need help getting started please don't hesitate to reach out. We are available in our CNCF slack channel, #kgateway, or you can join the community meeting to meet folks and ask for help there. We'd love to hear from you and help get your started on your open source journey. Links are available below in the [Big pull requests](#big-prs) section<!-- TODO: fix this, see the section on big PRs for contact details isn't great -->.

### DCO

Expand All @@ -31,13 +31,13 @@ The easiest way to signoff on your contributions is to use the `-s` flag on your

### Commit Signing

In order to help ensure the integrity of our code the K8sGateway project requires that your commits are signed and verified. For more details as well as instructions for setting up signing please review the [github docuementation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) about signing and verification of commits.
In order to help ensure the integrity of our code the kgateway project requires that your commits are signed and verified. For more details as well as instructions for setting up signing please review the [github docuementation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) about signing and verification of commits.

### Code review guidelines

It’s important that every piece of code in K8sGateway is reviewed by at least one maintainer familiar with that codebase.
It’s important that every piece of code in kgateway is reviewed by at least one maintainer familiar with that codebase.

1. **Changelog**: The K8sGateway project uses [GitHub's automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) feature. As such, make sure that your PR description includes a clear, concise message of the change, including any user-facing steps to use the feature. <!-- TODO: update this when all the changelog churn is worked out https://github.com/k8sgateway/k8sgateway/issues/10409 -->
1. **Changelog**: The kgateway project uses [GitHub's automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) feature. As such, make sure that your PR description includes a clear, concise message of the change, including any user-facing steps to use the feature. <!-- TODO: update this when all the changelog churn is worked out https://github.com/kgateway-dev/kgateway/issues/10409 -->
2. **CI check**: A maintainer needs to kick off the CI process by commenting `/test` on your PR.
3. **Testing**: Please write tests for your changes. Bias towards fast / unit testing.
4. **Comments**: The code reviewer may leave comments to discuss changes. Minor preferences are often called out with `nit`.
Expand All @@ -47,11 +47,11 @@ It’s important that every piece of code in K8sGateway is reviewed by at least

### Reporting Security Vulnerabilities

If you would like to report a security issue please refere to the [K8sGateway documentation site](https://k8sgateway.io/docs/reference/vulnerabilities/).
If you would like to report a security issue please refer to the [kgateway documentation site](https://k8sgateway.io/docs/reference/vulnerabilities/).

### Filing issues

If you encounter a bug, please file an issue on GitHub in the k8sgateway/k8sgateway repo.
If you encounter a bug, please file an issue on GitHub in the [kgateway](https://github.com/kgateway-dev/kgateway) repo.
If an issue you have is already reported, please add additional information or add a 👍 reaction to indicate your agreement.

### Small bug fixes
Expand All @@ -73,8 +73,8 @@ TODO: Document correct methods for reaching out
1. Community/contributor meeting
-->

1. **Open an issue**: Open an issue about your bug in the k8sgateway/k8sgateway repo.
2. **Message us on Slack**: Reach out to us to discuss your proposed changes in our [CNCF slack channel, #k8sgateway](https://cloud-native.slack.com/archives/C080D3PJMS4).
1. **Open an issue**: Open an issue about your bug in the [kgateway](https://github.com/kgateway-dev/kgateway) repo.
2. **Message us on Slack**: Reach out to us to discuss your proposed changes in our [CNCF slack channel, #kgateway](https://cloud-native.slack.com/archives/C080D3PJMS4).
3. **Agree on implementation plan**: Write a plan for how this feature or bug fix should be implemented. Should this be one pull request or multiple incremental improvements? Who is going to do each part? Discuss it with us on slack or join our [community meeting](https://calendar.google.com/calendar/u/1?cid=ZDI0MzgzOWExMGYwMzAxZjVkYjQ0YTU0NmQ1MDJmODA5YTBjZDcwZGI4ZTBhZGNhMzIwYWRlZjJkOTQ4MzU5Y0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t)
4. **Submit a draft PR**: It's important to get feedback as early as possible to ensure that any big improvements end up being merged. Open a draft pull request and label it `work in progress` to start getting feedback.
5. **Review**: At least one maintainer should sign off on the change before it’s merged. Look at the following [Code review](#code-review-guidelines) section to learn about what we're looking for.
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTOR_LADDER.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# K8sGateway Contributor Ladder
# Kgateway Contributor Ladder

This document describes the set of roles individuals may have within the community, the requirements of each role, and the contributor ladder for someone to grow.

Expand Down Expand Up @@ -40,18 +40,18 @@ An Organization Member must meet the responsibilities and has the requirements o
* Continues to contribute regularly, as demonstrated by having at least 3 GitHub contributions per year, as shown by Devstats.
* Requirements:
* Must have successful contributions to the project, including at least one merged PR.
* Must be member of the #k8sgateway channel on the [CNCF Slack](https://slack.cncf.io).
* Must be member of the #kgateway channel on the [CNCF Slack](https://slack.cncf.io).
* Must have [2FA](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa) enabled on your GitHub account.
* Privileges:
* May be assigned Issues and Reviews.
* May give commands to CI/CD automation.
* May label/triage issues.

To apply to become a member of the k8sgateway organization on GitHub, please open a GitHub PR in the community repository that contains the following:
1. Use the [membership request template](.github/PULL_REQUEST_TEMPLATE/apply_to_be_a_member.md). This template is linked from the default template when you open a PR, or you can paste this URL in your browser `https://github.com/k8sgateway/community/compare/main...<my-fork>:<my-branch>?quick_pull=1&title=Request%20org%20membership%20for%20<user>&labels=membership&template=apply_to_be_a_member.md`, replacing:
To apply to become a member of the kgateway-dev organization on GitHub, please open a GitHub PR in the community repository that contains the following:
1. Use the [membership request template](.github/PULL_REQUEST_TEMPLATE/apply_to_be_a_member.md). This template is linked from the default template when you open a PR, or you can paste this URL in your browser `https://github.com/kgateway-dev/community/compare/main...<my-fork>:<my-branch>?quick_pull=1&title=Request%20org%20membership%20for%20<user>&labels=membership&template=apply_to_be_a_member.md`, replacing:
- `<my-fork>:<my-branch>` with your fork/branch name, and
- `<user>` with your GitHub username
1. Add your GitHub username to the list of members (under `orgs.k8sgateway.members`) in our [organization file](./org.yaml). Please add your name in the correct alphabetical order to maintain a tidy organization file.
1. Add your GitHub username to the list of members (under `orgs.kgateway-dev.members`) in our [organization file](./org.yaml). Please add your name in the correct alphabetical order to maintain a tidy organization file.

### Reviewer

Expand Down
4 changes: 2 additions & 2 deletions CVE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# K8sGateway CVEs
# Kgateway CVEs

Thank you for your interest in the security of the K8sGateway Project. Information about common vulnerabilities and exposures (CVEs) can be found on the [K8sGateway documentation site](https://k8sgateway.io/docs/reference/vulnerabilities/).
Thank you for your interest in the security of the kgateway project. Information about common vulnerabilities and exposures (CVEs) can be found on the [kgateway documentation site](https://k8sgateway.io/docs/reference/vulnerabilities/).

12 changes: 6 additions & 6 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# K8sGateway governance
# Kgateway governance

K8sGateway is dedicated to building a feature-rich, fast and flexible next-generation API gateway. This governance document details how the project is run.
Kgateway is dedicated to building a feature-rich, fast and flexible next-generation API gateway. This governance document details how the project is run.

## Values

The K8sGateway project embraces the following values:
The kgateway project embraces the following values:

* Openness: Communication and decision-making happens in the open and is discoverable for future
reference. As much as possible, all discussions and work take place in public
Expand All @@ -30,7 +30,7 @@ Our governance builds on top of definitions from other documents, review the fol

## Voting

While most business in K8sGateway is conducted by "[lazy consensus](https://community.apache.org/committers/lazyConsensus.html)",
While most business in kgateway is conducted by "[lazy consensus](https://community.apache.org/committers/lazyConsensus.html)",
periodically the Maintainers may need to vote on specific actions or changes. The following rules govern our voting process, unless otherwise stated for a specific purpose.

* A vote begins when someone adds a PR comment containing the `/vote` command.
Expand All @@ -44,10 +44,10 @@ periodically the Maintainers may need to vote on specific actions or changes. Th
<!---
TODO: Enumerate what, precisely, constitutes a change in governance. I think it's clear editing this file, in any significant way, would count. Adjusting at least certain things wrt to the maintainer lifecycle also would likely constitute a governance change because this would directly impact who is, and is not, able to vote as well as who may be eligible or not in the future.
-->
All changes to our governance model require a vote by the maintainers. The proposed change will be submitted as a PR against the K8sGateway community repository. Voting will proceed according to the rules established for simple conflict resolution, with the sole exception being the threshold for acceptance.
All changes to our governance model require a vote by the maintainers. The proposed change will be submitted as a PR against the kgateway community repository. Voting will proceed according to the rules established for simple conflict resolution, with the sole exception being the threshold for acceptance.

* Any change requires a 2/3 super majority to be accepted.

## Vendor-neutrality

K8sGateway is committed to [vendor-neutrality](https://contribute.cncf.io/maintainers/community/vendor-neutrality/). Our governance process has been designed to limit the influence of individual companies in furtherance of this goal. If you have concerns about the vendor-neutrality of the project please open an issue in this repository or join our [community meeting](https://calendar.google.com/calendar/u/1?cid=ZDI0MzgzOWExMGYwMzAxZjVkYjQ0YTU0NmQ1MDJmODA5YTBjZDcwZGI4ZTBhZGNhMzIwYWRlZjJkOTQ4MzU5Y0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t) to discuss.
Kgateway is committed to [vendor-neutrality](https://contribute.cncf.io/maintainers/community/vendor-neutrality/). Our governance process has been designed to limit the influence of individual companies in furtherance of this goal. If you have concerns about the vendor-neutrality of the project please open an issue in this repository or join our [community meeting](https://calendar.google.com/calendar/u/1?cid=ZDI0MzgzOWExMGYwMzAxZjVkYjQ0YTU0NmQ1MDJmODA5YTBjZDcwZGI4ZTBhZGNhMzIwYWRlZjJkOTQ4MzU5Y0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t) to discuss.
2 changes: 1 addition & 1 deletion MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# K8sGateway maintainers
# Kgateway maintainers

## Active

Expand Down
Loading

0 comments on commit d3f039c

Please sign in to comment.