Make documentation for PingSource. #2126

n3wscott · 2020-01-23T00:27:37Z

Dependent on knative/eventing#2427

Document the renamed instructions for PingSource. Formally called CronJobSource.

matzew · 2020-01-23T14:18:37Z

/lgtm

samodell · 2020-01-23T23:10:02Z

Hey @n3wscott ! Should we also delete the references to CronJobSource in the docs when we merge this in?

n3wscott · 2020-01-25T00:17:47Z

Hey @n3wscott ! Should we also delete the references to CronJobSource in the docs when we merge this in?

Not yet, wait until post 0.14 release.

samodell

Oof, looks like I wrote these comments and never sent them out. Sorry for the delay on this!

docs/eventing/samples/ping-source/README.md

carieshmarie

Thanks for your PR! Just a few minor comments/requested changes.

docs/eventing/samples/ping-source/README.md

carieshmarie · 2020-02-27T01:05:30Z

docs/eventing/samples/ping-source/README.md

+
+## Cleanup
+
+You can delete the PingSource by entering the following command:


What exactly are you deleting here? Is it the event source? Or the YAML file? Can we add a noun to the sentence? i.e. "You can delete the Pingsource [NOUN] by entering the following command..."

My guess is the event source is created the same way as a service by applying a yaml file, so deleting the yaml file is deleting the source effectively?

abrennan89

Left a few additional comments

abrennan89 · 2020-02-27T13:44:56Z

docs/eventing/samples/ping-source/README.md

+---
+
+PingSource example shows how to configure PingSource as event source for
+functions.


Should this be services or Knative services rather than "functions"?

docs/eventing/samples/ping-source/README.md

abrennan89 · 2020-02-27T13:52:28Z

docs/eventing/samples/ping-source/README.md

+
+## Create a PingSource
+
+For each set of ping events you want to request, you need to create an Event


"For each set of ping events you want to request" - would someone set up a bunch of different PingSource event sources though for each service, or would they have one PingSource and then use the broker and filters to send the events to different services? I don't think it's clear how this is used.

docs/eventing/samples/ping-source/README.md

abrennan89 · 2020-02-27T13:57:47Z

docs/eventing/samples/ping-source/README.md

+
+## Cleanup
+
+You can delete the PingSource by entering the following command:


My guess is the event source is created the same way as a service by applying a yaml file, so deleting the yaml file is deleting the source effectively?

abrennan89 · 2020-02-27T13:59:28Z

docs/eventing/samples/ping-source/service.yaml

@@ -0,0 +1,11 @@
+# This is a very simple Knative Service that writes the input request to its log.


Maybe mention that it's an event input request or something?

it is used all over, maybe we can migrate to a central doc to talk about this?

Maybe time to resurrect #170 ?

abrennan89 · 2020-02-27T14:01:19Z

Hey @n3wscott ! Should we also delete the references to CronJobSource in the docs when we merge this in?

Not yet, wait until post 0.14 release.

@mattmoor should we add an issue to update this to the 0.14 release milestone?

googlebot · 2020-02-27T14:56:47Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

commit 9a04cb6 Author: Scott Nichols <snichols@vmware.com> Date: Thu Feb 27 07:32:03 2020 -0800 Document ping source.

n3wscott · 2020-02-27T15:50:08Z

@googlebot I fixed it.

googlebot · 2020-02-27T15:50:14Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

mattmoor · 2020-02-27T16:12:25Z

/approve

mattmoor · 2020-02-27T16:13:46Z

☝️ I'm triggering stagedoc-bot for scott, so also adding:

/hold

knative-prow-robot · 2020-02-27T17:05:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abrennan89, mattmoor, n3wscott

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~~ [mattmoor]

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

docs/eventing/samples/ping-source/README.md

docs/eventing/samples/ping-source/service.yaml

matzew · 2020-02-27T19:11:44Z

/lgtm

lionelvillard · 2020-03-03T21:12:11Z

@n3wscott is this ready?

matzew · 2020-03-05T13:24:36Z

@n3wscott I've updated it, here:

n3wscott#1

feel free to squash it in

n3wscott · 2020-03-05T14:24:21Z

I would like to merge this and then do a pass on the entire codebase updating to v1alpha2 for pingsource

n3wscott · 2020-03-05T14:24:46Z

This is ready, has been for a week

mattmoor · 2020-03-05T15:10:30Z

We should (separately) get the eventing WG leads added to OWNERS for this area of the code. I'm surprised Scotty needs approval here.

@carieshmarie anything else here?

n3wscott · 2020-03-05T17:08:40Z

/unhold

matzew · 2020-03-09T11:08:50Z

/lgtm

* Document ping source. * Squashed commit of the following: commit 9a04cb6 Author: Scott Nichols <snichols@vmware.com> Date: Thu Feb 27 07:32:03 2020 -0800 Document ping source. * typo on source. * update image * kail tabs * by name default

googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Jan 23, 2020

knative-prow-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 23, 2020

knative-prow-robot requested review from RichieEscarez and samodell January 23, 2020 00:27

knative-prow-robot assigned matzew Jan 23, 2020

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 23, 2020

samodell suggested changes Feb 13, 2020

View reviewed changes

knative-prow-robot removed the lgtm Indicates that a PR is ready to be merged. label Feb 26, 2020

carieshmarie suggested changes Feb 27, 2020

View reviewed changes

abrennan89 suggested changes Feb 27, 2020

View reviewed changes

abrennan89 removed the request for review from RichieEscarez February 27, 2020 14:00

googlebot added cla: no Indicates the PR's author has not signed the CLA. and removed cla: yes Indicates the PR's author has signed the CLA. labels Feb 27, 2020

mattmoor reviewed Feb 27, 2020

View reviewed changes

Document ping source.

9a04cb6

n3wscott force-pushed the pingsource branch from ae9d42b to 9a04cb6 Compare February 27, 2020 15:37

Squashed commit of the following:

df1f129

commit 9a04cb6 Author: Scott Nichols <snichols@vmware.com> Date: Thu Feb 27 07:32:03 2020 -0800 Document ping source.

googlebot added cla: yes Indicates the PR's author has signed the CLA. and removed cla: no Indicates the PR's author has not signed the CLA. labels Feb 27, 2020

knative-prow-robot added the approved label Feb 27, 2020

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

abrennan89 approved these changes Feb 27, 2020

View reviewed changes

matzew reviewed Feb 27, 2020

View reviewed changes

docs/eventing/samples/ping-source/README.md Outdated Show resolved Hide resolved

matzew reviewed Feb 27, 2020

View reviewed changes

docs/eventing/samples/ping-source/README.md Outdated Show resolved Hide resolved

typo on source.

c5aa069

matzew reviewed Feb 27, 2020

View reviewed changes

docs/eventing/samples/ping-source/service.yaml Outdated Show resolved Hide resolved

Scott Nichols added 3 commits February 27, 2020 10:57

Merge branch 'pingsource' of github.com:n3wscott/docs into pingsource

36f1838

update image

485eea0

kail tabs

1e2f734

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 27, 2020

by name default

a1e2c7a

knative-prow-robot removed the lgtm Indicates that a PR is ready to be merged. label Feb 28, 2020

vaikas mentioned this pull request Feb 28, 2020

Update docs to v1beta1 + add more details about channel based broker #2259

Merged

lionelvillard mentioned this pull request Mar 3, 2020

update parallel doc to v1beta1 #2266

Merged

matzew mentioned this pull request Mar 5, 2020

Updates on the PingSource #2274

Merged

knative-prow-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 5, 2020

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 9, 2020

knative-prow-robot merged commit c44c757 into knative:master Mar 9, 2020

This was referenced Mar 13, 2020

[RELEASE 0.13] CP of: Make documentation for PingSource. (#2126) #2309

Closed

[RELEASE 0.13] Cherrypick 2126 #2310

Merged


		## Cleanup

		You can delete the PingSource by entering the following command:


		## Create a PingSource

		For each set of ping events you want to request, you need to create an Event

		@@ -0,0 +1,11 @@
		# This is a very simple Knative Service that writes the input request to its log.

Make documentation for PingSource. #2126

Make documentation for PingSource. #2126

Uh oh!

Conversation

n3wscott commented Jan 23, 2020

Uh oh!

matzew commented Jan 23, 2020

Uh oh!

samodell commented Jan 23, 2020

Uh oh!

n3wscott commented Jan 25, 2020

Uh oh!

samodell left a comment

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!

carieshmarie left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abrennan89 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

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!

abrennan89 commented Feb 27, 2020

Uh oh!

googlebot commented Feb 27, 2020

Uh oh!

n3wscott commented Feb 27, 2020

Uh oh!

googlebot commented Feb 27, 2020

Uh oh!

mattmoor commented Feb 27, 2020

Uh oh!

mattmoor commented Feb 27, 2020

Uh oh!

knative-prow-robot commented Feb 27, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matzew commented Feb 27, 2020

Uh oh!

lionelvillard commented Mar 3, 2020

Uh oh!

matzew commented Mar 5, 2020

Uh oh!