Skip to content

Commit 0df2ea4

Browse files
author
Vincent
authored
Refactor the README (#1145)
1 parent 7d97b3a commit 0df2ea4

File tree

4 files changed

+36
-449
lines changed

4 files changed

+36
-449
lines changed

Diff for: README.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
11
# Knative Operator
22

3+
[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/github.com/knative/operator)
4+
[![Go Report Card](https://goreportcard.com/badge/knative/operator)](https://goreportcard.com/report/knative/operator)
5+
[![Releases](https://img.shields.io/github/release-pre/knative/operator.svg?sort=semver)](https://github.com/knative/operator/releases)
6+
[![LICENSE](https://img.shields.io/github/license/knative/operator.svg)](https://github.com/knative/operator/blob/main/LICENSE)
7+
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://knative.slack.com)
8+
[![codecov](https://codecov.io/gh/knative/operator/branch/main/graph/badge.svg)](https://codecov.io/gh/knative/operator)
9+
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5913/badge)](https://bestpractices.coreinfrastructure.org/projects/5913)
10+
311
The Knative Operator defines custom resources for the
4-
[Knative](https://knative.dev/) components, [serving](config/300-serving.yaml)
5-
and [eventing](config/300-eventing.yaml), enabling users to configure, install,
12+
[Knative](https://knative.dev/) components, including serving and eventing, enabling users to configure, install,
613
upgrade and maintain these components over their lifecycle through a simple API.
714

815
Details:
916

10-
- [Installation](docs/installation.md)
11-
- [Configuration](docs/configuration.md)
17+
- [Installation](https://knative.dev/docs/install/operator/knative-with-operators/)
18+
- [Serving Configuration](https://knative.dev/docs/install/operator/configuring-serving-cr/)
19+
- [Eventing Configuration](https://knative.dev/docs/install/operator/configuring-eventing-cr/)
20+
- [Upgrade](docs/upgrade.md)
1221
- [Development](docs/development.md)
1322
- [Release](docs/release.md)
23+
24+
For documentation on using Knative Operator, see the
25+
[Knative operator section](https://knative.dev/docs/install/operator/knative-with-operators/) of the
26+
[Knative documentation site](https://www.knative.dev/docs).
27+
28+
If you are interested in contributing, see [CONTRIBUTING.md](./CONTRIBUTING.md)
29+
and [DEVELOPMENT.md](./DEVELOPMENT.md).

Diff for: docs/configuration.md

-320
This file was deleted.

0 commit comments

Comments
 (0)