Broker and source docs improvements #555

gabo1208 · 2021-12-17T16:54:41Z

Changes

🎁 New samples docs and files
🧹 Updated old source and broker docs (still some work to do but it's a start)

/kind documentation

Fixes #553

Release Note

Improved Broker's and Source's Readme docs and Samples description and files.

Docs

codecov · 2021-12-17T17:29:15Z

Codecov Report

Merging #555 (a9bcc88) into main (06ba8e7) will decrease coverage by 0.08%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #555      +/-   ##
==========================================
- Coverage   75.58%   75.50%   -0.09%     
==========================================
  Files          47       47              
  Lines        2892     2870      -22     
==========================================
- Hits         2186     2167      -19     
+ Misses        568      565       -3     
  Partials      138      138

Impacted Files	Coverage Δ
pkg/reconciler/broker/broker.go	`89.38% <0.00%> (-0.62%)`	⬇️
pkg/reconciler/trigger/trigger.go	`59.84% <0.00%> (-0.53%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 06ba8e7...a9bcc88. Read the comment docs.

samples/source/concurrent-dispatch/100-namespace.yaml

pkg/reconciler/source/resources/receive_adapter.go

broker/README.md

samples/source/README.md

source/README.md

xtreme-sameer-vohra · 2022-01-07T04:06:27Z

source/README.md

+
+### Installation
+
+* Install the source from the nightly build:


Should this be moved to the Development.md instead?

I'm thinking about getting read of the Development.md (maybe there are some things to keep) but with this readme and the samples I think everything should be covered

…escription

…example promoting the use of internal tools and with all the components needed to do a basic topology + set the prefetch count to use its default value to one but added comment on the file for the user to be able to modify it and understand whats going on

added some extra info and fixed typo fixed style error in yaml added some extra info and fixed typo, removing trailing spaces from source sample readme

xtreme-sameer-vohra

Thanks @gabo1208 it's looking great :)
Added some minor comments and there are a few comments from before.

samples/broker-trigger/README.md

xtreme-sameer-vohra · 2022-01-12T22:47:16Z

samples/broker-trigger/README.md

 NAME      URL                                                        AGE     READY   REASON
-default   http://default-broker-ingress.dlq-demo.svc.cluster.local   2m39s   True
+default   http://default-broker-ingress.broker-trigger-demo.svc.cluster.local   2m39s   True


Thanks for fixing the formatting.
Thoughts on moving kubectl -n broker-trigger-demo get brokers to after the Broker install ?

xtreme-sameer-vohra

It would be valuable for the samples to simplify the setup required to run them, so does it make sense to refer to the releases of the Broker and Source and remove references to building them from source code ?

samples/broker-trigger/README.md

samples/source/README.md

broker/README.md

…link + added source readme steps to build and install the source + added source example and fixed some typos and broken links

added newline at the end of the source sample file added newline to source dev md file fixed typo in source md

readded table of contents to the source

changed development references to readme changed source readme formats

broker/README.md

gabo1208 · 2022-01-07T19:54:43Z

samples/broker-trigger/README.md

 NAME      URL                                                        AGE     READY   REASON
-default   http://default-broker-ingress.dlq-demo.svc.cluster.local   2m39s   True
+default   http://default-broker-ingress.broker-trigger-demo.svc.cluster.local   2m39s   True


Done with the headers

And i think here its ok cause since the ksvc is the broker's sink so the msg may change

gabo1208 · 2022-01-07T19:56:54Z

samples/broker-trigger/README.md

+### Cleanup
+
+```sh
+kubectl delete ns broker-trigger-demo


Seems to be the standard on knative docs to do the ns delete. I see what you mean but for all of the samples in this repo this work

gabo1208 · 2022-01-07T20:11:07Z

samples/source/README.md

+### Cleanup
+
+```sh
+kubectl delete ns source-demo


answered above

gabo1208 · 2022-01-07T20:18:09Z

source/README.md

+
+### Installation
+
+* Install the source from the nightly build:


I'm thinking about getting read of the Development.md (maybe there are some things to keep) but with this readme and the samples I think everything should be covered

samples/broker-trigger/README.md

gabo1208 · 2022-01-13T15:08:16Z

samples/broker-trigger/README.md

 NAME      URL                                                        AGE     READY   REASON
-default   http://default-broker-ingress.dlq-demo.svc.cluster.local   2m39s   True
+default   http://default-broker-ingress.broker-trigger-demo.svc.cluster.local   2m39s   True


Since the broker has a DLQ defined it could be not ready if we list it earlier

source/README.md

xtreme-sameer-vohra · 2022-01-18T19:44:20Z

/lgtm

xtreme-sameer-vohra · 2022-01-18T19:44:53Z

Thanks for driving this @gabo1208 👍

knative-prow-robot · 2022-01-18T19:45:17Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gabo1208, xtreme-sameer-vohra

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~~ [xtreme-sameer-vohra]

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

knative-prow-robot added kind/documentation needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 17, 2021

gabo1208 force-pushed the broker-and-source-docs-improvements branch from 42d4626 to 10f63ae Compare December 17, 2021 17:23

knative-prow-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 17, 2021

gabo1208 force-pushed the broker-and-source-docs-improvements branch 4 times, most recently from f8d0ca4 to 8b61ea4 Compare December 17, 2021 23:01

xtreme-sameer-vohra self-requested a review January 3, 2022 14:41

gabo1208 force-pushed the broker-and-source-docs-improvements branch 2 times, most recently from 2ada76f to a014efb Compare January 6, 2022 15:16

xtreme-sameer-vohra suggested changes Jan 7, 2022

View reviewed changes

knative-prow-robot assigned xtreme-sameer-vohra Jan 7, 2022

gabo1208 added 7 commits January 7, 2022 15:22

Added source sample files

ae1af64

modified sample files structure and added comments

bad6d64

modified files distribution on source sample and fixed readme table d…

f451025

…escription

Commented prefetch count annotation on broker-trigger sample

a662ca3

added files to broker samples and fixed the sample description

9848dc7

transforming source adoc to md

cdd2eb9

added some extra info and fixed typo fixed style error in yaml added some extra info and fixed typo, removing trailing spaces from source sample readme

gabo1208 force-pushed the broker-and-source-docs-improvements branch from a014efb to d65d6f2 Compare January 7, 2022 20:23

fixed pr comments

50ee0cd

gabo1208 force-pushed the broker-and-source-docs-improvements branch from d65d6f2 to 50ee0cd Compare January 7, 2022 20:40

xtreme-sameer-vohra requested a review from salaboy January 10, 2022 15:00

xtreme-sameer-vohra suggested changes Jan 12, 2022

View reviewed changes

fixed pr broker an source prerequisites

d09a2e2

xtreme-sameer-vohra suggested changes Jan 13, 2022

View reviewed changes

samples/broker-trigger/README.md Outdated Show resolved Hide resolved

samples/broker-trigger/README.md Outdated Show resolved Hide resolved

samples/source/README.md Outdated Show resolved Hide resolved

samples/source/README.md Outdated Show resolved Hide resolved

xtreme-sameer-vohra reviewed Jan 13, 2022

View reviewed changes

broker/README.md Outdated Show resolved Hide resolved

removed unnused instrucction and fixed broker's sample prerequisites …

f6769cf

…link + added source readme steps to build and install the source + added source example and fixed some typos and broken links

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 Jan 13, 2022

gabo1208 force-pushed the broker-and-source-docs-improvements branch from 6bad5df to 3ac8233 Compare January 13, 2022 19:37

added file with the source's knobs in yaml

6a69856

added newline at the end of the source sample file added newline to source dev md file fixed typo in source md

gabo1208 force-pushed the broker-and-source-docs-improvements branch from 3ac8233 to 6a69856 Compare January 13, 2022 19:45

gabo1208 requested a review from xtreme-sameer-vohra January 13, 2022 19:50

gabo1208 added 2 commits January 13, 2022 20:29

reestructured source docs files and fixed broken link

cddd0c9

readded table of contents to the source

changed main for master in eventing branches and fixed formats

6d3d320

changed development references to readme changed source readme formats

gabo1208 force-pushed the broker-and-source-docs-improvements branch from 8f06cee to 6d3d320 Compare January 14, 2022 01:46

gabo1208 commented Jan 14, 2022

View reviewed changes

Update source/README.md

a9bcc88

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

xtreme-sameer-vohra approved these changes Jan 18, 2022

View reviewed changes

knative-prow-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 18, 2022

knative-prow-robot merged commit 169e951 into knative-extensions:main Jan 18, 2022

gabo1208 mentioned this pull request Jan 18, 2022

Samples on how to use Knative + RabbitMQ #416

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Broker and source docs improvements #555

Broker and source docs improvements #555

gabo1208 commented Dec 17, 2021 •

edited

Loading

codecov bot commented Dec 17, 2021 •

edited

Loading

xtreme-sameer-vohra Jan 7, 2022

gabo1208 Jan 7, 2022

xtreme-sameer-vohra left a comment

xtreme-sameer-vohra Jan 12, 2022

xtreme-sameer-vohra left a comment

gabo1208 Jan 7, 2022

gabo1208 Jan 7, 2022

gabo1208 Jan 7, 2022

gabo1208 Jan 7, 2022

gabo1208 Jan 13, 2022

xtreme-sameer-vohra commented Jan 18, 2022

xtreme-sameer-vohra commented Jan 18, 2022

knative-prow-robot commented Jan 18, 2022


		### Installation

		* Install the source from the nightly build:

Broker and source docs improvements #555

Broker and source docs improvements #555

Conversation

gabo1208 commented Dec 17, 2021 • edited Loading

Changes

codecov bot commented Dec 17, 2021 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xtreme-sameer-vohra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xtreme-sameer-vohra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xtreme-sameer-vohra commented Jan 18, 2022

xtreme-sameer-vohra commented Jan 18, 2022

knative-prow-robot commented Jan 18, 2022

gabo1208 commented Dec 17, 2021 •

edited

Loading

codecov bot commented Dec 17, 2021 •

edited

Loading