Skip to content

Commit f429287

Browse files
authored
Include a page that gives an overview of the user facing projects of Knative (#1703)
* Include a page that gives an overview of the user facing projects of Knative * Include some supporting projects like the website and test/infra
1 parent 51aa6c0 commit f429287

File tree

2 files changed

+61
-6
lines changed

2 files changed

+61
-6
lines changed

PROJECTS.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Knative Project Overview
2+
3+
## Functions
4+
5+
[func](https://github.com/knative/func) provides a simple programming model for using functions on Knative, without requiring in-depth knowledge of Knative, Kubernetes, containers, or dockerfiles.
6+
7+
## Serving
8+
9+
[Serving](https://github.com/knative/serving) defines a set of resources to manage how your serverless workload behaves on the Kubernetes cluster.
10+
11+
### Related Sub-projects
12+
13+
#### Networking Plugins
14+
15+
[Networking plugins](https://github.com/knative-extensions?q=net-&type=public) provide a shim to converts generic Serving resources to networking specific ones. Example integrations are Istio, Contour, Gateway API and Kourier.
16+
17+
#### Client
18+
19+
The [`kn` cli](https://github.com/knative/client) provides a quick and easy interface for creating Knative resources such as services and event sources, without the need to create or modify YAML files directly. kn also simplifies completion of otherwise complex procedures such as autoscaling and traffic splitting.
20+
21+
#### Operator
22+
23+
The [Operator](https://github.com/knative/operator) helps install, manage and upgrade Knative Serving installations on Kubernetes Clusters.
24+
25+
## Eventing
26+
27+
[Eventing](https://github.com/knative/eventing) is a collection of APIs that enable you to use an event-driven architecture with your applications. You can use these APIs to create components that route events from event producers (known as sources) to event consumers (known as sinks) that receive events.
28+
29+
### Related Sub-projects
30+
31+
#### Eventing Plugins
32+
33+
[Eventing plugins](https://github.com/knative-extensions?q=eventing-&type=public&language=&sort=) allow end-users to integrate Knative with various different eventing buses/queues such as Kafka, Redis, NATS, Rabbit-MQ.
34+
35+
#### Client
36+
37+
The [`kn` cli](https://github.com/knative/client) provides a quick and easy interface for creating Knative resources such as services and event sources, without the need to create or modify YAML files directly. kn also simplifies completion of otherwise complex procedures such as autoscaling and traffic splitting.
38+
39+
#### Operator
40+
41+
The [Operator](https://github.com/knative/operator) helps install, manage and upgrade Knative Eventing installations on Kubernetes Clusters.
42+
43+
## Other Supporting Subprojects
44+
45+
### Knative Website
46+
47+
The [`knative.dev`] website is where users learn about using and operating different components of Knative.
48+
49+
### Knative Infrastructure
50+
51+
The test infrastructure hosts our CI and other various tooling to support development of Knative Kubernetes components. [`knative/infra`](https://github.com/knative/infra) contains documentation on how to get involved.
52+
53+
## Additional Resources
54+
55+
Knative projects are maintained by organized [working groups](./working-groups/WORKING-GROUPS.md).
56+
57+
Additionally, see the [Knative website](https://knative.dev) for in-depth information.
58+

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
## Welcome!
2-
3-
Welcome to the Knative community!
1+
## Welcome to the Knative community!
42

53
![Kuack the Knative Duck](./mascot/kuack.png)
4+
65
*Meet Kuack, the Knative Duck - our community mascot!*
76

87
This is the starting point for becoming a contributor - improving code,
@@ -40,9 +39,7 @@ Other Documents
4039
## Introduction
4140

4241
Knative is a Kubernetes-based platform to deploy and manage modern serverless
43-
workloads. See the
44-
[Knative documentation](https://knative.dev) for in-depth information about
45-
using Knative.
42+
workloads. It composed of several [subprojects](./PROJECTS.md)
4643

4744
## Knative authors
4845

0 commit comments

Comments
 (0)