Skip to content

Commit

Permalink
Merge branch 'main' into add-cali0707-eventing-reviewer
Browse files Browse the repository at this point in the history
  • Loading branch information
Cali0707 committed Sep 5, 2023
2 parents 37fdf4f + 625ea8e commit 6bff28c
Show file tree
Hide file tree
Showing 40 changed files with 475 additions and 835 deletions.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/ADOPTERS.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Let us know you are using Knative
description: If your company is using Knative in production or some stage of development, please add your company information here and it will be added to the ADOPTERS.md file.
title: "[ADOPTERS]: ${COMPANY NAME HERE}"
labels: ["kind/documentation", "size/S"]
body:
- type: markdown
attributes:
value: |
🥳 Thanks for taking the time to let us know you are using Knative! Welcome to the community. 🥳
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. [email protected]
validations:
required: false
- type: input
id: company
attributes:
label: Company or Organization
description: Tell us what your company or organization's name is
placeholder: Company or organization name
validations:
required: true
- type: input
id: product
attributes:
label: Product or Project
description: If you would like to share the name of the product or project where you are using Knative, we'd love to know!
placeholder: Product or project name
validations:
required: false
- type: checkboxes
id: status
attributes:
label: Status
description: How are you using Knative today?
options:
- label: We have a project or product that is in development
- label: We have a project or product that is publicly available in prerelease form
- label: We have a project or product that is in production and publicly available
- label: We have a project or product that is in production and used internally
- type: input
id: info-link
attributes:
label: Where can we learn more?
description: If you have a link to information about your project or your usage of Knative, please let us know!
placeholder: https://link.to/awesome/project
- type: textarea
id: more
attributes:
label: More information
description: If you would like to share any more information with us about how you are using Knative or your plans for the future, we'd love to hear about it.
26 changes: 14 additions & 12 deletions .github/ISSUE_TEMPLATE/new-repo.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
name: Request a new repo
about: Request creation of a new repo in the knative or knative-sandbox orgs
about: Request creation of a new repo in the knative or knative-extensions orgs
title: "New Repo: `$REPONAME`"
---

Use this issue type to request a new repo in `knative-sandbox` (or
Use this issue type to request a new repo in `knative-extensions` (or
`knative`, which may require additional discussion).

<!-- Update the information below with your request -->

## Repo information

Org: `knative-sandbox`
Org: `knative-extensions`

Repo: `$REPONAME`

Expand All @@ -23,15 +23,15 @@ Sponsoring WG:

## Actions to fulfill

This area is used to track the [repo creation process](https://github.com/knative/community/blob/main/mechanics/CREATING-A-SANDBOX-REPO.md).
This area is used to track the [repo creation process](https://github.com/knative/community/blob/main/mechanics/CREATING-AN-EXTENSIONS-REPO.md).
The _requestor_ and _sponsoring WG lead_ should perform the steps listed below and cross out the checkmarks when done.
The TOC is involved only in the **TOC Gate** steps.

- [ ] Add this issue to the [TOC project board](https://github.com/orgs/knative/projects/43) for review. You are responsible for moving your entry on the board to "Needs Discussion" or "In Progress" as you move forward in this checklist.

_You may not be able to use the Projects quick menu on this page. In that case, go to the project board and use the **Add cards** interface._

- [ ] Send a PR adding entries for this repo in [`/peribolos/knative-sandbox.yaml`](https://github.com/knative/community/blob/main/peribolos/knative-sandbox.yaml). Please mind the alphabetical order when adding to a list.
- [ ] Send a PR adding entries for this repo in [`/peribolos/knative-extensions.yaml`](https://github.com/knative/community/blob/main/peribolos/knative-extensions.yaml). Please mind the alphabetical order when adding to a list.
- [ ] Add the repository and a description.
- [ ] Grant `Knative Admin` the `admin` privilege.
- [ ] Grant the sponsoring WG the `write` privilege.
Expand All @@ -43,27 +43,29 @@ _You may not be able to use the Projects quick menu on this page. In that case,
- [ ] (golang) Send a PR to add aliases for `knative.dev/$REPONAME` import paths ([sample](https://github.com/knative/docs/pull/4160)).

- [ ] Have a lead from the sponsoring WG bootstrap the Git repository by pushing an
appropriate "template" repository ([basic](https://github.com/knative-sandbox/wg-repository),
[sample-controller](https://github.com/knative-sandbox/sample-controller),
[sample-source](https://github.com/knative-sandbox/sample-source)) to the new repository as
appropriate "template" repository ([basic](https://github.com/knative-extensions/wg-repository),
[sample-controller](https://github.com/knative-extensions/sample-controller),
[sample-source](https://github.com/knative-extensions/sample-source)) to the new repository as
a git remote. For example:

```shell
git clone https://github.com/knative-sandbox/sample-controller.git
git clone https://github.com/knative-extensions/sample-controller.git
cd sample-controller
git remote add newrepo https://github.com/knative-sandbox/$REPONAME.git
git remote add newrepo https://github.com/knative-extensions/$REPONAME.git
git push newrepo main
```

- [ ] Add your GitHub ID to the `OWNERS` file for your repo.

- [ ] [Set up](https://github.com/knative/test-infra/blob/main/guides/prow_knative_setup.md#setting-up-prow-for-a-new-repo-reviewers-assignment-and-auto-merge) prow for a new repo

- [ ] Bootstrap your CI jobs using [hack](https://github.com/knative/hack) project (look at other sandbox repos for reference)
- [ ] Bootstrap your CI jobs using [hack](https://github.com/knative/hack) project (look at other extensions repos for reference)

- [ ] Create a sample PR to verify Prow (e.g., edit the boilerplate README)

- [ ] Verify that within 24 hours the appropriate branch protections have been applied
requiring `tide` to pass before PRs are merged.

- [ ] (optional) Send a PR adding the repo to [knobots](https://github.com/knative-sandbox/knobots).
- [ ] (optional) Send a PR adding the repo to [knobots](https://github.com/knative-extensions/knobots).

- [ ] (optional) Send a PR adding the repo to [CLOMonitor](https://clomonitor.io/projects/cncf/knative) ([more information](/REPOSITORY-GUIDELINES.md#clomonitor-and-clotributor)).
4 changes: 2 additions & 2 deletions .github/workflows/peribolos-schema-validate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ jobs:
- run: pip install strictyaml
- name: Validate knative.yaml
run: python3 peribolos/validate-schema.py peribolos/knative.yaml
- name: Validate knative-sandbox.yaml
run: python3 peribolos/validate-schema.py peribolos/knative-sandbox.yaml
- name: Validate knative-extensions.yaml
run: python3 peribolos/validate-schema.py peribolos/knative-extensions.yaml
2 changes: 1 addition & 1 deletion .github/workflows/verify.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

# This file is **********NOT********** automagically synced here by knobots
# because its too hard to opt-in to a single action. See
# https://github.com/knative-sandbox/knobots/pull/99 for a potential solution.
# https://github.com/knative-extensions/knobots/pull/99 for a potential solution.

name: Verify

Expand Down
5 changes: 4 additions & 1 deletion ADOPTERS.MD
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This page contains a list of organizations who are using Knative in production or in stages of development.

If you would like to be included in this table, please submit a comment to [this issue](https://github.com/knative/community/issues/696) and your information will be added.
If you would like to be included in this table, please open [an issue](https://github.com/knative/community/issues/new?assignees=&labels=kind%2Fdocumentation%2Csize%2FS&projects=&template=ADOPTERS.yaml&title=%5BADOPTERS%5D%3A+%24%7BCOMPANY+NAME+HERE%7D) and your information will be added.

## Adopters

Expand All @@ -26,14 +26,17 @@ If you would like to be included in this table, please submit a comment to [this
| Liquidx* | InBlock | Production | [link](https://www.liquidx.com/) |
| [ManoMano](https://www.manomano.es/) | | Development & Production | [link](https://www.manomano.es/) |
| Optum* | | Production | [link](https://optum.com/) |
| Property.xyz* | Property.xyz | Production | [link](https://property.xyz/) |
| Red Hat | Red Hat OpenShift Serverless | Generally Available | [link](https://www.openshift.com/learn/topics/serverless) |
| Scaleway* | | Public Beta | [link](https://www.scaleway.com/en) |
| Sonavi Labs | Sonavi Cloud | Public Beta | [link](https://www.sonavilabs.com) |
| Spider.com* | | Development | [link](https://www.spider.com) |
| Tata Communications* | | Development | [link](https://www.tatacommunications.com/solutions/cloud/platforms) |
| TriggerMesh* | | Production | [link](https://triggermesh.com) |
| VMware | Cloud Native Runtimes for VMware Tanzu | Generally Available | [link](https://network.tanzu.vmware.com/products/serverless) |
| VMware | VMware Event Broker Appliance | Development | [link](https://vmweventbroker.io/) |
| vorteil pty ltd* | Serverless orchestration engine | Development & Production | [link](http://vorteil.io) |
| KA-NABELL* | Largest trading card E-commerce in Japan | Development | [link](https://www.ka-nabell.com) |
| Y Meadows* | AI and Workflow Automation Platform for Customer Service | Production | [link](https://www.ymeadows.com) |

`*` organization that is an end user of Knative and not a vendor/reseller
44 changes: 35 additions & 9 deletions REPOSITORY-GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,23 +96,23 @@ repository is retired and no longer maintained.

It is beneficial for Knative working groups to be able to own code outside the
core `knative` organization, which is kept intentionally small and has a high
bar for entry. The `knative-sandbox` GitHub organization was created for this
purpose. Repositories in `knative-sandbox` are intended to give working groups
bar for entry. The `knative-extensions` GitHub organization was created for this
purpose. Repositories in `knative-extensions` are intended to give working groups
more latitude to experiment with new ideas and to self-organize and manage
contributions which may be important to the project but which do not need the
level of governance of the core project.

Note that `knative-sandbox` is **not** an incubation area for projects entering
the `knative` github org; in most cases, projects in the sandbox will remain
there for the entire duration. `knative-sandbox` also provides a location for
Note that `knative-extensions` is **not** an incubation area for projects entering
the `knative` github org; in most cases, projects in the extensions will remain
there for the entire duration. `knative-extensions` also provides a location for
implementations of core interfaces which do not themselves need to be part of
every knative installation, such as networking or eventing integrations. In the
event that a working group wants a project in sandbox to be considered for
event that a working group wants a project in extensions to be considered for
transfer to the `knative` org, the request will be considered on a case-by-case
basis by joint decision of the Steering Committee and the Technical Oversight
Committee.

### Mechanics of working-group owned repositories in `knative-sandbox`
### Mechanics of working-group owned repositories in `knative-extensions`

#### Creation

Expand Down Expand Up @@ -189,7 +189,7 @@ The following are not required to create a working-group-owned repository:
### The fine print

Steering and Trademark reserve the right to require that repos be removed or
transferred out of the `knative-sandbox` organization and API groups to be
transferred out of the `knative-extensions` organization and API groups to be
renamed. This is intended to simplify the process in the common case, while
giving Steering or Trademark the ability to step in and rectify problems that
may arise.
Expand All @@ -198,10 +198,36 @@ may arise.

Working groups are responsible for the upkeep of their repositories and are
expected to keep a high quality bar. Inactive or non-conforming repositories
should be archived, deleted, or moved out of the `knative-sandbox` organization,
should be archived, deleted, or moved out of the `knative-extensions` organization,
following the general [Procedure for Removal](#procedure-for-removal) for
repositories.

## CLOMonitor and CLOTributor

[CLOMonitor](https://clomonitor.io/) is a CNCF tool that periodically checks open source projects repositories to verify they meet certain project health best practices.

[CLOTributor](https://clotributor.dev/) is a CNCF tool that makes it easier to discover great opportunities to become a Cloud Native contributor.

When a new repository is created, consider adding it to CLOMonitor [data file](https://github.com/cncf/clomonitor/blob/main/data/cncf.yaml), similar to:

```yaml
- name: eventing
url: https://github.com/knative/eventing
check_sets:
- code-lite
```
This will make the repository will be listed in CLOMonitor's Knative project [health report](https://clomonitor.io/projects/cncf/knative). It will also make CLOTributor to list `good-first-issue`s of the new repository.

If you would like to exclude the repository from the health report but have the `good-first-issues` in CLOTributor, add following the field:

```yaml
exclude:
- clomonitor
```

Based on the maturity of the repository, it is possible to use different `check_sets`. See CLOMonitor's [checks documentation](https://github.com/cncf/clomonitor/blob/main/docs/checks.md) for more information.

---

Contents of this page are adopted from the
Expand Down
Loading

0 comments on commit 6bff28c

Please sign in to comment.