Skip to content

Add Broker/Trigger docs from eventing repo #1279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
May 17, 2019
Merged

Add Broker/Trigger docs from eventing repo #1279

merged 3 commits into from
May 17, 2019

Conversation

@grantr
Copy link
Contributor

@grantr grantr commented May 6, 2019

Mostly a copy of https://github.com/knative/eventing/blob/e4637d3d854c06ebce7041a08a2191e17003ce66/docs/broker/README.mdgithub.com/knative/eventing/docs/broker/README.md, but
with a new intro and without the Implementation section.

All of these words were written by @Harwayne. This was originally more targeted to contributors, so it probably needs some massaging to be useful to users.

Fixes #1023
/label cherrypick-0.5

@grantr
Add Broker/Trigger docs from eventing repo
1c2a1b2 
Mostly a copy of github.com/knative/eventing/docs/broker/README.md, but
with a new intro and without the Implementation section.
@googlebot googlebot added the cla: yes Indicates the PR's author has signed the CLA. label May 6, 2019
@knative-prow-robot knative-prow-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 6, 2019
@nachocano
Copy link
Contributor

nachocano commented May 8, 2019

Depending on this one for #1285

@RichieEscarez RichieEscarez self-assigned this May 8, 2019
@nachocano nachocano mentioned this pull request May 10, 2019
Merged
sebgoa
sebgoa suggested changes May 13, 2019
View reviewed changes
Copy link
Contributor

@sebgoa sebgoa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor edits

@grantr
Copy link
Contributor Author

grantr commented May 15, 2019

Thanks @sebgoa for your feedback! Updated and RFAL.

samodell
samodell suggested changes May 15, 2019
View reviewed changes
Copy link
Contributor

@samodell samodell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few suggestions -- I agree this could be re-written from more of a user perspective, but in the name of expediency I think we can merge this in after these changes.

docs/eventing/broker-trigger.md Outdated
@@ -0,0 +1,273 @@
# Broker and Trigger
Copy link
Contributor

@samodell samodell May 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Broker and Trigger
---
title: "Broker and Trigger"
weight: 20
type: "docs"
---

Copy link
Contributor

@samodell samodell May 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the necessary format for the page to be pulled into the left-nav on the website.

Copy link
Contributor Author

@grantr grantr May 16, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.

docs/eventing/broker-trigger.md Outdated

### ClusterChannelProvisioner

`Broker`'s use their `spec.channelTemplate` to create their internal `Channel`s,
Copy link
Contributor

@samodell samodell May 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`Broker`'s use their `spec.channelTemplate` to create their internal `Channel`s,
`Broker`s use their `spec.channelTemplate` to create their internal `Channel`s,

Copy link
Contributor Author

@grantr grantr May 16, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

grantr
grantr commented May 16, 2019
View reviewed changes
Copy link
Contributor Author

@grantr grantr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review @samodell! I committed your changes manually rather than accepting suggestions to avoid confusing CLABot.

docs/eventing/broker-trigger.md Outdated
@@ -0,0 +1,273 @@
# Broker and Trigger
Copy link
Contributor Author

@grantr grantr May 16, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.

docs/eventing/broker-trigger.md Outdated

### ClusterChannelProvisioner

`Broker`'s use their `spec.channelTemplate` to create their internal `Channel`s,
Copy link
Contributor Author

@grantr grantr May 16, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@samodell
Copy link
Contributor

samodell commented May 17, 2019

/lgtm
/approve

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label May 17, 2019
@knative-prow-robot
Copy link
Contributor

knative-prow-robot commented May 17, 2019

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: grantr, samodell

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:

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

@samodell samodell added this to the v0.6 docs milestone May 17, 2019
@knative-prow-robot knative-prow-robot merged commit 1c0a2f2 into knative:master May 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gyliu513 gyliu513 Awaiting requested review from gyliu513

@RichieEscarez RichieEscarez Awaiting requested review from RichieEscarez

2 more reviewers

@sebgoa sebgoa sebgoa requested changes

@samodell samodell samodell requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

@samodell samodell

Labels

cla: yes Indicates the PR's author has signed the CLA. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

v0.6 docs

Development

Successfully merging this pull request may close these issues.

Eventing repo docs -- edit new broker/trigger content

7 participants

@grantr @nachocano @samodell @knative-prow-robot @sebgoa @googlebot @RichieEscarez