Relocate event source docs #3948
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -71,13 +71,33 @@ nav: | |
| - Debugging application issues: developer/serving/troubleshooting/debugging-application-issues.md | ||
| - Knative Eventing: | ||
| - Event sources: | ||
| - Overview: developer/eventing/sources/README.md | ||
| - Creating an event source: | ||
| - Overview: developer/eventing/sources/creating-event-sources/README.md | ||
| - Writing an event source using Javascript: developer/eventing/sources/creating-event-sources/writing-event-source-easy-way/README.md | ||
| - Using the sample event source: | ||
| - Overview: developer/eventing/sources/creating-event-sources/writing-event-source/README.md | ||
| - Design of an Event Source: developer/eventing/sources/creating-event-sources/writing-event-source/01-theory.md | ||
| - Lifecycle and Types: developer/eventing/sources/creating-event-sources/writing-event-source/02-lifecycle-and-types.md | ||
| - Controller Implemetation: developer/eventing/sources/creating-event-sources/writing-event-source/03-controller.md | ||
| - Reconciler Implementation: developer/eventing/sources/creating-event-sources/writing-event-source/04-reconciler.md | ||
| - Receive Adapter Implementation: developer/eventing/sources/creating-event-sources/writing-event-source/05-receive-adapter.md | ||
| - Publishing to your cluster: developer/eventing/sources/creating-event-sources/writing-event-source/06-yaml.md | ||
| - Moving to knative-sandbox: developer/eventing/sources/creating-event-sources/writing-event-source/07-knative-sandbox.md | ||
| - ApiServerSource: | ||
| - Overview: developer/eventing/sources/apiserversource/README.md | ||
| - Creating an ApiServerSource object: developer/eventing/sources/apiserversource/getting-started/README.md | ||
| - ApiServerSource reference: developer/eventing/sources/apiserversource/reference.md | ||
| - Camel source: developer/eventing/sources/apache-camel-source/README.md | ||
| - ContainerSource: | ||
| - Creating a ContainerSource object: developer/eventing/sources/containersource/README.md | ||
| - ContainerSource Reference: developer/eventing/sources/containersource/reference.md | ||
| - Kafka source: developer/eventing/sources/kafka-source/README.md | ||
| - PingSource: developer/eventing/sources/ping-source/README.md | ||
| - SinkBinding: | ||
| - Overview: developer/eventing/sources/sinkbinding/README.md | ||
| - Creating a SinkBinding object: developer/eventing/sources/sinkbinding/getting-started.md | ||
| - SinkBinding reference: developer/eventing/sources/sinkbinding/reference.md | ||
| - Event delivery: developer/eventing/event-delivery.md | ||
| - Event sinks: | ||
| - About sinks: developer/eventing/sinks/README.md | ||
|
|
@@ -157,27 +177,6 @@ nav: | |
| - Knative Eventing: | ||
| - Overview: eventing/README.md | ||
| - Getting started: eventing/getting-started.md | ||
| - Event registry: eventing/event-registry.md | ||
| - Flows: | ||
| - Overview: eventing/flows/README.md | ||
|
|
@@ -207,7 +206,7 @@ nav: | |
| - Experimental Features: eventing/experimental-features.md | ||
| - Code samples: | ||
| - Overview: eventing/samples/README.md | ||
| - Container source: eventing/samples/container-source/README.md | ||
| - Hello World: | ||
| - Overview: eventing/samples/helloworld/README.md | ||
| - GO: eventing/samples/helloworld/helloworld-go/README.md | ||
|
|
@@ -220,12 +219,12 @@ nav: | |
| - Overview: eventing/samples/parallel/README.md | ||
| - Multiple Cases: eventing/samples/parallel/multiple-branches/README.md | ||
| - Mutual Exclusivity: eventing/samples/parallel/mutual-exclusivity/README.md | ||
| - CloudAuditLogsSource: eventing/samples/cloud-audit-logs-source/README.md | ||
| - CloudPubSubSource: eventing/samples/cloud-pubsub-source/README.md | ||
| - CloudSchedulerSource: eventing/samples/cloud-scheduler-source/README.md | ||
| - CloudStorageSource: eventing/samples/cloud-storage-source/README.md | ||
| - GitHub source: eventing/samples/github-source/README.md | ||
| - GitLab source: eventing/samples/gitlab-source/README.md | ||
|
Comment on lines
+222
to
+227
Contributor
There was a problem hiding this comment. Same for all of these, idk why they wouldn't be part of the single Event Source docs section?
Contributor
Author
There was a problem hiding this comment. I was confused about what to do with samples. There were three options I could think of (I was not sure which one we plan to do so I just left them where they were):
I think if we have all the samples in the same place it might be easier to link to from the What's Next page, but this is not a strongly held position. Will deal with samples in #3796
Contributor
There was a problem hiding this comment. I would prefer we don't have a samples section at all and just add them as part of the main docs for each thing they're a sample of. As a user I wouldn't want to look in two different places for docs on how to create a resource and then samples for them. For example, rather than having a GitLab source sample somewhere, just add GitLab source to the main event source docs and use the sample as a basis for documenting it properly. |
||
| - IoT core: eventing/samples/iot-core/README.md | ||
| # Reference docs | ||
| - Reference: | ||
|
|
@@ -239,4 +238,3 @@ nav: | |
| - kn plugins: client/kn-plugins.md | ||
| - "Join the Community ➠": /community/ | ||
| - "Read the Blog ➠": /blog/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.