knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update readme (#26)

This commit is contained in:
Ryan Gregg 2018-06-27 11:32:13 -07:00 committed by GitHub
parent b0b8f66204
commit aa2299f6fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
README.md
View File

@ -19,52 +19,36 @@ turn frees application developers to spend more time writing
interesting code, not worrying about how they are going to build, interesting code, not worrying about how they are going to build,
deploy, monitor, and debug it. deploy, monitor, and debug it.
## Getting started with Knative
# What are the Knative components? To get started using Knative, [pick a Kubernetes cluster of your choice](https://kubernetes.io/docs/setup/pick-right-solution/)
and follow the [Knative installation instructions](/install/install-on-gke.md)
to get the system up.
Currently, Knative consists of the following top-level repositories: There are a [number of samples](serving/samples/README.md) to help you get acquanted you can build
and run on your cluster once it's set up.
- [build](https://github.com/knative/build) and
[build-templates](https://github.com/knative/build-templates) —
automatic, repeatable server-side container builds
- [serving](https://github.com/knative/serving) — scale to zero,
request-driven compute
- [eventing](https://github.com/knative/eventing) — management and
delivery of events
We expect this list to grow as more areas are identified.
# How do I use Knative?
You can choose to install individual Knative components following the You can choose to install individual Knative components following the
instructions in each repo, or install a pre-built suite of components instructions in each repo, or install a pre-built suite of components
by following the instructions at https://github.com/knative/install. by following the instructions for your platform:
- [Google Kubernetes Engine](install/install-on-gke.md)
- [MiniKube](install/install-on-minikube.md)
# Who is Knative for? ## Who is Knative for
Knative is being created with several Knative was created with several personas in mind:
[personas](./docs/product/personas.md) in mind.
**Developers** ### Developers
Knative components offer Kubernetes-native APIs for deploying Knative components offer Kubernetes-native APIs for deploying
functions, applications, and containers to an auto-scaling runtime. serverless-style functions, applications, and containers to an auto-scaling
runtime.
To get started as a developer, [pick a Kubernetes cluster of your To join the conversation, head over to the
choice](https://kubernetes.io/docs/setup/pick-right-solution/) and [Knative Users](https://groups.google.com/d/forum/knative-users) Google group.
follow the [Knative installation
instructions](https://github.com/knative/install) to get the system up
and running and [run some sample code](./sample/README.md). The
install instructions also include a [sample
application](https://github.com/knative/install#test-app) which
demonstrates some of the key features of Knative.
To join the conversation, head over to ### Operators
https://groups.google.com/d/forum/knative-users.
**Operators**
Knative components are intended to be integrated into more polished Knative components are intended to be integrated into more polished
products that cloud service providers or in-house teams in large products that cloud service providers or in-house teams in large
@ -73,19 +57,35 @@ enterprises can then operate.
Any enterprise or cloud provider can adopt Knative components into Any enterprise or cloud provider can adopt Knative components into
their own systems and pass the benefits along to their customers. their own systems and pass the benefits along to their customers.
**Contributors** ### Contributors
With a clear project scope, lightweight governance model and clean With a clear project scope, lightweight governance model and clean
lines of separation between pluggable components, the Knative project lines of separation between pluggable components, the Knative project
establishes an efficient contributor workflow. establishes an efficient contributor workflow.
Knative is a diverse, open, and inclusive community. To get involved, Knative is a diverse, open, and inclusive community. To get involved,
see [CONTRIBUTING.md](./CONTRIBUTING.md) and see [CONTRIBUTING.md](https://github.com/knative/serving/CONTRIBUTING.md) and
[DEVELOPMENT.md](./DEVELOPMENT.md) and join the [DEVELOPMENT.md](https://github.com/knative/serving/DEVELOPMENT.md) and join the
[#community](https://knative.slack.com/messages/C92U2C59P/) Slack [#community](https://knative.slack.com/messages/C92U2C59P/) Slack channel.
channel.
Your own path to becoming a Knative contributor can [begin Your own path to becoming a Knative contributor can
anywhere](https://github.com/knative/serving/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). [begin anywhere](https://github.com/knative/serving/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
[Bug reports](https://github.com/knative/serving/issues/new) and [Bug reports](https://github.com/knative/serving/issues/new) and
friction logs from new developers are especially welcome. friction logs from new developers are especially welcome.
## What are the Knative components
Currently, Knative consists of the following top-level repositories:
- [build](https://github.com/knative/build) and
[build-templates](https://github.com/knative/build-templates) —
automatic, repeatable server-side container builds
- [docs](https://github.com/knative/docs) - documentation for developers and
operators using Knative components.
- [eventing](https://github.com/knative/eventing) — management and
delivery of events
- [serving](https://github.com/knative/serving) — scale to zero,
request-driven compute
We expect this list to grow as more areas are identified.