Skip to content

Commit 75c6e88

Browse files
RichieEscarezsamodell
authored andcommitted
Clarify "event sources" NOT "Knative eventing sources" (#1535)
* clarify eventing resources (not just sources) * Update docs/eventing/debugging/README.md Co-Authored-By: Sam O'Dell <[email protected]>
1 parent 6204204 commit 75c6e88

File tree

4 files changed

+20
-9
lines changed

4 files changed

+20
-9
lines changed

docs/eventing/debugging/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ know roughly how things fit together.
1111

1212
This document works with
1313
[Eventing 0.3](https://github.com/knative/eventing/releases/tag/v0.3.0) and
14-
[Eventing Sources 0.3](https://github.com/knative/eventing-contrib/releases/tag/v0.3.0).
14+
[Eventing-contrib resources 0.3](https://github.com/knative/eventing-contrib/releases/tag/v0.3.0).
1515

1616
## Prerequisites
1717

18-
1. Setup [Knative Eventing and Eventing-Sources](../README.md).
18+
1. Setup [Knative Eventing and an Eventing-contrib resource](../README.md).
1919

2020
## Example
2121

22-
This guide uses an example consisting of an Event Source sending events to a
23-
function.
22+
This guide uses an example consisting of an event source that sends
23+
events to a function.
2424

2525
![src -> chan -> sub -> svc -> fn](ExampleModel.png)
2626

docs/reference/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The API source files are located at:
1212
- [Serving API](./serving.md)
1313
- [Build API](./build.md)
1414
- [Eventing API](./eventing/eventing.md)
15-
- [Event Sources API](./eventing/eventing-sources.md)
15+
- [Eventing-contrib resources API](./eventing/eventing-resources.md)
1616

1717
## Updating API Reference docs (for Knative maintainers)
1818

@@ -60,7 +60,7 @@ To generate a version of the API:
6060

6161
- [Build](https://github.com/knative/build/releases/)
6262
- [Eventing](https://github.com/knative/eventing/releases/)
63-
- [Eventing Sources](https://github.com/knative/eventing-contrib/releases/)
63+
- [Eventing-contrib resources](https://github.com/knative/eventing-contrib/releases/)
6464
- [Serving](https://github.com/knative/serving/releases/)
6565

6666
1. To run the `gen-api-reference-docs.sh` command from the `hack` directory, you
Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
---
2-
title: "Knative Eventing Contrib"
2+
title: "Eventing-contrib Resources"
33
linkTitle: "Eventing-contrib API"
44
weight: 50
55
type: "docs"
6+
aliases:
7+
- /docs/reference/eventing/eventing-contrib-resources/
68
---
79

810

9-
The API content for the source implementations that integrate with Knative Eventing are located in the [Knative/eventing-contrib](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib) repo.
11+
The API definitions for the Eventing resources that conform to
12+
Knative Eventing are located in the
13+
[`knative/eventing-contrib`](https://github.com/knative/eventing-contrib/tree/release-0.7/)
14+
repo:
15+
16+
- [`awssqs` source](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib/awssqs/pkg/apis/sources/v1alpha1)
17+
- [`camel` source](https://github.com/knative/eventing-contrib/tree/release-0.7/camel/source/pkg/apis/sources/v1alpha1)
18+
- [`gcppubsub` source](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib/gcppubsub/pkg/apis/sources/v1alpha1)
19+
- [`github` source](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib/github/pkg/apis/sources/v1alpha1)
20+
- [`kafka` source](https://github.com/knative/eventing-contrib/tree/release-0.7/kafka/source/pkg/apis/sources/v1alpha1)

hack/gen-api-reference-docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ KNATIVE_EVENTING_OUT_FILE="eventing/eventing.md"
3939

4040
KNATIVE_EVENTING_SOURCES_REPO="github.com/knative/eventing-contrib"
4141
KNATIVE_EVENTING_SOURCES_COMMIT="${KNATIVE_EVENTING_SOURCES_COMMIT:?specify the \$KNATIVE_EVENTING_SOURCES_COMMIT variable}"
42-
KNATIVE_EVENTING_SOURCES_OUT_FILE="eventing/eventing-sources.md"
42+
KNATIVE_EVENTING_SOURCES_OUT_FILE="eventing/eventing-contrib-resources.md"
4343

4444
cleanup_refdocs_root=
4545
cleanup_repo_clone_root=

0 commit comments

Comments
 (0)