Skip to content

Commit aa2299f

Browse files
authored
Update readme (tensorflow#26)
1 parent b0b8f66 commit aa2299f

File tree

1 file changed

+40
-40
lines changed

1 file changed

+40
-40
lines changed

README.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -19,52 +19,36 @@ turn frees application developers to spend more time writing
1919
interesting code, not worrying about how they are going to build,
2020
deploy, monitor, and debug it.
2121

22+
## Getting started with Knative
2223

23-
# What are the Knative components?
24+
To get started using Knative, [pick a Kubernetes cluster of your choice](https://kubernetes.io/docs/setup/pick-right-solution/)
25+
and follow the [Knative installation instructions](/install/install-on-gke.md)
26+
to get the system up.
2427

25-
Currently, Knative consists of the following top-level repositories:
26-
27-
- [build](https://github.com/knative/build) and
28-
[build-templates](https://github.com/knative/build-templates)
29-
automatic, repeatable server-side container builds
30-
- [serving](https://github.com/knative/serving) — scale to zero,
31-
request-driven compute
32-
- [eventing](https://github.com/knative/eventing) — management and
33-
delivery of events
34-
35-
We expect this list to grow as more areas are identified.
36-
37-
38-
# How do I use Knative?
28+
There are a [number of samples](serving/samples/README.md) to help you get acquanted you can build
29+
and run on your cluster once it's set up.
3930

4031
You can choose to install individual Knative components following the
4132
instructions in each repo, or install a pre-built suite of components
42-
by following the instructions at https://github.com/knative/install.
33+
by following the instructions for your platform:
4334

35+
- [Google Kubernetes Engine](install/install-on-gke.md)
36+
- [MiniKube](install/install-on-minikube.md)
4437

45-
# Who is Knative for?
38+
## Who is Knative for
4639

47-
Knative is being created with several
48-
[personas](./docs/product/personas.md) in mind.
40+
Knative was created with several personas in mind:
4941

50-
**Developers**
42+
### Developers
5143

5244
Knative components offer Kubernetes-native APIs for deploying
53-
functions, applications, and containers to an auto-scaling runtime.
54-
55-
To get started as a developer, [pick a Kubernetes cluster of your
56-
choice](https://kubernetes.io/docs/setup/pick-right-solution/) and
57-
follow the [Knative installation
58-
instructions](https://github.com/knative/install) to get the system up
59-
and running and [run some sample code](./sample/README.md). The
60-
install instructions also include a [sample
61-
application](https://github.com/knative/install#test-app) which
62-
demonstrates some of the key features of Knative.
45+
serverless-style functions, applications, and containers to an auto-scaling
46+
runtime.
6347

64-
To join the conversation, head over to
65-
https://groups.google.com/d/forum/knative-users.
48+
To join the conversation, head over to the
49+
[Knative Users](https://groups.google.com/d/forum/knative-users) Google group.
6650

67-
**Operators**
51+
### Operators
6852

6953
Knative components are intended to be integrated into more polished
7054
products that cloud service providers or in-house teams in large
@@ -73,19 +57,35 @@ enterprises can then operate.
7357
Any enterprise or cloud provider can adopt Knative components into
7458
their own systems and pass the benefits along to their customers.
7559

76-
**Contributors**
60+
### Contributors
7761

7862
With a clear project scope, lightweight governance model and clean
7963
lines of separation between pluggable components, the Knative project
8064
establishes an efficient contributor workflow.
8165

8266
Knative is a diverse, open, and inclusive community. To get involved,
83-
see [CONTRIBUTING.md](./CONTRIBUTING.md) and
84-
[DEVELOPMENT.md](./DEVELOPMENT.md) and join the
85-
[#community](https://knative.slack.com/messages/C92U2C59P/) Slack
86-
channel.
67+
see [CONTRIBUTING.md](https://github.com/knative/serving/CONTRIBUTING.md) and
68+
[DEVELOPMENT.md](https://github.com/knative/serving/DEVELOPMENT.md) and join the
69+
[#community](https://knative.slack.com/messages/C92U2C59P/) Slack channel.
8770

88-
Your own path to becoming a Knative contributor can [begin
89-
anywhere](https://github.com/knative/serving/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
71+
Your own path to becoming a Knative contributor can
72+
[begin anywhere](https://github.com/knative/serving/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
9073
[Bug reports](https://github.com/knative/serving/issues/new) and
9174
friction logs from new developers are especially welcome.
75+
76+
## What are the Knative components
77+
78+
Currently, Knative consists of the following top-level repositories:
79+
80+
- [build](https://github.com/knative/build) and
81+
[build-templates](https://github.com/knative/build-templates)
82+
automatic, repeatable server-side container builds
83+
- [docs](https://github.com/knative/docs) - documentation for developers and
84+
operators using Knative components.
85+
- [eventing](https://github.com/knative/eventing) — management and
86+
delivery of events
87+
- [serving](https://github.com/knative/serving) — scale to zero,
88+
request-driven compute
89+
90+
We expect this list to grow as more areas are identified.
91+

0 commit comments

Comments
 (0)