Add docs / samples for Sequence #1481

vaikas · 2019-06-18T12:59:11Z

Proposed Changes

Add documentation for Sequence + samples

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md

matzew · 2019-06-18T14:51:56Z

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md

+
+### Create the Sequence
+
+Here, if you are using different type of Channel, you need to change the


wouldnt that be always, w/ the new API/CRDs, there is no "default" channel, AFAIK

Yeah, I mean if they don't want to use InMemoryChannel, say they want to use Kafka, they need to set their environment up differently.

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md

vaikas · 2019-06-18T19:15:08Z

Thanks for the review, PTALl

docs/eventing/samples/sequence/sequence-reply-to-sequence/README.md

samodell · 2019-06-18T19:55:39Z

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md

@@ -0,0 +1,194 @@
+---
+title: "Sequence Wired to event-display"


Nice write up, @vaikas-google ! I'll review this later today.

This PR has a lot more than I realized! Here's my first round of edits; still have a little more I'd like to do, but wanted to get these over to you.

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md

docs/eventing/samples/sequence/sequence-reply-to-sequence/README.md

docs/eventing/samples/sequence/sequence-terminal/README.md

docs/eventing/samples/sequence/sequence-with-broker-trigger/README.md

docs/eventing/samples/sequence/sequence-with-broker-trigger/display-trigger.yaml

docs/eventing/sequence.md

vaikas · 2019-06-19T05:35:51Z

Thanks for the reviews. I believe I addressed all the feedback, PTAL.

n3wscott · 2019-06-19T20:32:26Z

/lgtm

n3wscott · 2019-06-19T20:32:52Z

/hold
docs can hold cancel

samodell · 2019-06-19T20:42:46Z

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md

+type: "docs"
+---
+
+# Using Sequences in series


I'm wondering if we can come up with a title that explicitly states the value of doing this -- what do you get from using sequences in a series? What use-case is this ideal for?

(This is the first time I've seen the term "Sequence" in the context of Eventing; could be really helpful to add links out to more info if this is a new object we've added.

Ah, yes, add a link to the sequence page you created further down in this PR :)

I could add a backpointer to it, however, my thinking was that the landing page will be sequence.md and then the links point to specific examples like this.
Perhaps, I should switch Prerequisites with the Overview and then from Overview add the link to Sequence (../../../../sequence.md)?

@vaikas-google It's very hard to guarantee a particular reading path (thanks to Google search, people sharing links in Slack, people's own preferences when browsing, etc.) so it's best to add links to related content so that people can find the information no matter where they land.

I would be in favor of moving "Overview" up before "Prerequisites" and adding a link to the sequence page there.

samodell · 2019-06-19T21:06:33Z

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md

+## Prerequisites
+
+For this example, we'll assume you have set up an `InMemoryChannel`
+as well as Knative Serving (for our functions). The examples use `default`


Suggested change

as well as Knative Serving (for our functions). The examples use `default`

as well as Knative Serving (for our functions). The examples use the `default`

samodell · 2019-06-19T21:06:56Z

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md

+
+For this example, we'll assume you have set up an `InMemoryChannel`
+as well as Knative Serving (for our functions). The examples use `default`
+namespace, again, if you want to deploy to another Namespace, you will need


Suggested change

namespace, again, if you want to deploy to another Namespace, you will need

namespace. If you want to deploy to another namespace, you will need

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md

docs/eventing/sequence.md

samodell · 2019-06-20T00:03:27Z

docs/eventing/sequence.md

+
+## Usage
+
+### Sequence Spec


Would it make sense to include an example of a typical Sequence specification?

docs/eventing/sequence.md

samodell · 2019-06-20T00:08:23Z

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md

@@ -0,0 +1,194 @@
+---
+title: "Sequence Wired to event-display"


This PR has a lot more than I realized! Here's my first round of edits; still have a little more I'd like to do, but wanted to get these over to you.

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md

samodell · 2019-06-25T17:33:35Z

/lgtm

knative-prow-robot · 2019-06-25T17:38:44Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: samodell, vaikas-google

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [samodell,vaikas-google]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

* sequence with broker * add sequence -> sequence sample * sequence wired to event display * terminal sequence * first two examples moved to new v1beta1 services + cascading changes * fix sequence2sequence to use v1beta services / default ns * fix broker example to use v1beta1 service + default ns * Address PR feedback * add a pointer to vaikas-google/transformer sample * update transformer image refs to latest * address PR feedback * move overview before prerequisites, add link to main sequence page

sequence with broker

5b12a23

knative-prow-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 18, 2019

googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Jun 18, 2019

knative-prow-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. approved labels Jun 18, 2019

knative-prow-robot requested review from RichieEscarez and samodell June 18, 2019 12:59

add sequence -> sequence sample

ac46e8a

knative-prow-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 18, 2019

sequence wired to event display

298db19

knative-prow-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jun 18, 2019

terminal sequence

6702e40

mikehelmick self-assigned this Jun 18, 2019

vaikas mentioned this pull request Jun 18, 2019

[BUG] Can not feed back events from a Sequence to a broker knative/eventing#1421

Closed

matzew reviewed Jun 18, 2019

View reviewed changes

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md Outdated Show resolved Hide resolved

matzew reviewed Jun 18, 2019

View reviewed changes

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md Outdated Show resolved Hide resolved

Ville Aikas added 4 commits June 18, 2019 20:19

Merge branch 'master' of github.com:knative/docs into sequence-docs

b5edd8f

first two examples moved to new v1beta1 services + cascading changes

c36d981

fix sequence2sequence to use v1beta services / default ns

bb5c7c0

fix broker example to use v1beta1 service + default ns

2ad2d1a

samodell reviewed Jun 18, 2019

View reviewed changes

n3wscott reviewed Jun 18, 2019

View reviewed changes

Address PR feedback

39b6f04

vaikas changed the title ~~[WIP] Add docs / samples for Sequence~~ Add docs / samples for Sequence Jun 19, 2019

knative-prow-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 19, 2019

Ville Aikas added 2 commits June 19, 2019 09:30

add a pointer to vaikas-google/transformer sample

bdf7d93

update transformer image refs to latest

a45d70e

vaikas mentioned this pull request Jun 19, 2019

[BUG] Servings Addressable usage not working with eventing? knative/eventing#1425

Closed

samodell self-assigned this Jun 19, 2019

knative-prow-robot assigned n3wscott Jun 19, 2019

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 19, 2019

knative-prow-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 19, 2019

samodell suggested changes Jun 20, 2019

View reviewed changes

samodell reviewed Jun 20, 2019

View reviewed changes

docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md Outdated Show resolved Hide resolved

address PR feedback

1f9ba7f

knative-prow-robot removed the lgtm Indicates that a PR is ready to be merged. label Jun 20, 2019

move overview before prerequisites, add link to main sequence page

ab11ab0

samodell removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 25, 2019

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 25, 2019

samodell mentioned this pull request Jun 25, 2019

Edit Sequence docs #1521

Closed

samodell approved these changes Jun 25, 2019

View reviewed changes

knative-prow-robot merged commit c050da8 into knative:master Jun 25, 2019

vaikas deleted the sequence-docs branch July 19, 2019 17:25


		### Create the Sequence

		Here, if you are using different type of Channel, you need to change the

		@@ -0,0 +1,194 @@
		---
		title: "Sequence Wired to event-display"

	as well as Knative Serving (for our functions). The examples use `default`
	as well as Knative Serving (for our functions). The examples use the `default`

	namespace, again, if you want to deploy to another Namespace, you will need
	namespace. If you want to deploy to another namespace, you will need

Add docs / samples for Sequence #1481

Add docs / samples for Sequence #1481

Uh oh!

Conversation

vaikas commented Jun 18, 2019

Proposed Changes

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vaikas commented Jun 18, 2019

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vaikas commented Jun 19, 2019

Uh oh!

n3wscott commented Jun 19, 2019

Uh oh!

n3wscott commented Jun 19, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

samodell commented Jun 25, 2019

Uh oh!

knative-prow-robot commented Jun 25, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants