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

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 <31352624+samodell@users.noreply.github.com>
This commit is contained in:
RichieEscarez 2019-06-26 15:32:06 -07:00 committed by Knative Prow Robot
parent 6204204d43
commit 75c6e88fa8
4 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/eventing/debugging/README.md
View File

@ -11,16 +11,16 @@ know roughly how things fit together.
This document works with This document works with
[Eventing 0.3](https://github.com/knative/eventing/releases/tag/v0.3.0) and [Eventing 0.3](https://github.com/knative/eventing/releases/tag/v0.3.0) and
[Eventing Sources 0.3](https://github.com/knative/eventing-contrib/releases/tag/v0.3.0). [Eventing-contrib resources 0.3](https://github.com/knative/eventing-contrib/releases/tag/v0.3.0).
## Prerequisites ## Prerequisites
1. Setup [Knative Eventing and Eventing-Sources](../README.md). 1. Setup [Knative Eventing and an Eventing-contrib resource](../README.md).
## Example ## Example
This guide uses an example consisting of an Event Source sending events to a This guide uses an example consisting of an event source that sends
function. events to a function.
![src -> chan -> sub -> svc -> fn](ExampleModel.png) ![src -> chan -> sub -> svc -> fn](ExampleModel.png)

4
docs/reference/README.md
View File

@ -12,7 +12,7 @@ The API source files are located at:
- [Serving API](./serving.md) - [Serving API](./serving.md)
- [Build API](./build.md) - [Build API](./build.md)
- [Eventing API](./eventing/eventing.md) - [Eventing API](./eventing/eventing.md)
- [Event Sources API](./eventing/eventing-sources.md) - [Eventing-contrib resources API](./eventing/eventing-resources.md)
## Updating API Reference docs (for Knative maintainers) ## Updating API Reference docs (for Knative maintainers)
@ -60,7 +60,7 @@ To generate a version of the API:
- [Build](https://github.com/knative/build/releases/) - [Build](https://github.com/knative/build/releases/)
- [Eventing](https://github.com/knative/eventing/releases/) - [Eventing](https://github.com/knative/eventing/releases/)
- [Eventing Sources](https://github.com/knative/eventing-contrib/releases/) - [Eventing-contrib resources](https://github.com/knative/eventing-contrib/releases/)
- [Serving](https://github.com/knative/serving/releases/) - [Serving](https://github.com/knative/serving/releases/)
1. To run the `gen-api-reference-docs.sh` command from the `hack` directory, you 1. To run the `gen-api-reference-docs.sh` command from the `hack` directory, you

15
docs/reference/eventing/eventing-contrib-api.md
View File

@ -1,9 +1,20 @@
--- ---
title: "Knative Eventing Contrib" title: "Eventing-contrib Resources"
linkTitle: "Eventing-contrib API" linkTitle: "Eventing-contrib API"
weight: 50 weight: 50
type: "docs" type: "docs"
aliases:
- /docs/reference/eventing/eventing-contrib-resources/
--- ---
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. The API definitions for the Eventing resources that conform to
Knative Eventing are located in the
[`knative/eventing-contrib`](https://github.com/knative/eventing-contrib/tree/release-0.7/)
repo:
- [`awssqs` source](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib/awssqs/pkg/apis/sources/v1alpha1)
- [`camel` source](https://github.com/knative/eventing-contrib/tree/release-0.7/camel/source/pkg/apis/sources/v1alpha1)
- [`gcppubsub` source](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib/gcppubsub/pkg/apis/sources/v1alpha1)
- [`github` source](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib/github/pkg/apis/sources/v1alpha1)
- [`kafka` source](https://github.com/knative/eventing-contrib/tree/release-0.7/kafka/source/pkg/apis/sources/v1alpha1)

2
hack/gen-api-reference-docs.sh
View File

@ -39,7 +39,7 @@ KNATIVE_EVENTING_OUT_FILE="eventing/eventing.md"
KNATIVE_EVENTING_SOURCES_REPO="github.com/knative/eventing-contrib" KNATIVE_EVENTING_SOURCES_REPO="github.com/knative/eventing-contrib"
KNATIVE_EVENTING_SOURCES_COMMIT="${KNATIVE_EVENTING_SOURCES_COMMIT:?specify the \$KNATIVE_EVENTING_SOURCES_COMMIT variable}" KNATIVE_EVENTING_SOURCES_COMMIT="${KNATIVE_EVENTING_SOURCES_COMMIT:?specify the \$KNATIVE_EVENTING_SOURCES_COMMIT variable}"
KNATIVE_EVENTING_SOURCES_OUT_FILE="eventing/eventing-sources.md" KNATIVE_EVENTING_SOURCES_OUT_FILE="eventing/eventing-contrib-resources.md"
cleanup_refdocs_root= cleanup_refdocs_root=
cleanup_repo_clone_root= cleanup_repo_clone_root=