knative
Add more information about Broker Developer Configuration Options
Currently the docs for the Developer Configuration Options of a Broker are only providing an example for a Broker object and some little description. It would be good, if this page could follow the style of the admin configuration options and describe the different configuration options for developers in a more fine grained approach.
Additional Info
-
In #5501 we added some more documentation about the MTChannelBasedBroker and updated the Creating a Broker page to reflect not only the MTChannelBasedBroker. During this we added the "Broker class options" section, which probably could be moved to the new Developer Configuration Options page.
-
The broker_types.go file in the eventing repo contains all the fields of a Broker.
-
The docs style guide provides useful information about the Knative standards and conventions. Especially the style-and-formatting.md should be helpful
This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
hi @creydr
I see you've added help-wanted label to this issue. If you think this is a good good-first-issue, can you:
- Comment with
/good-first-issue? - Add clear instructions (including code pointers) about how this issue can be resolved?
@aliok I updated the description a bit. Initially I was not sure if this is a good-first-issue as the user should know a bit about Brokers. But if the assignee feels comfortable they should be good to go.
/good-first-issue
@creydr: This request has been marked as suitable for new contributors.
Please ensure the request meets the requirements listed here.
If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.
In response to this:
@aliok I updated the description a bit. Initially I was not sure if this is a good-first-issue as the user should know a bit about Brokers. But if the assignee feels comfortable they should be good to go.
/good-first-issue
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
![knative-prow[bot] avatar](https://avatars.githubusercontent.com/in/183726?v=4 "Published by a pub.dev verified publisher"){kind=small}
This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.
Hello @AHB102, thanks for showing interest in this issue. It is still open. I am happy to help, if you have any questions.
/assign @AHB102
This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.
Hello @AHB102, are you still working on this issue? Can we help you somehow on this?
Hello @AHB102, are you still working on this issue? Can we help you somehow on this?
I am a mq engineer. I would like to contribute to it. Is it still open?
Hello,
as I haven't seen any contributions for this so far from I would clear the assignment to make it free for others again. In case anybody else wants to work on it, comment /assign (to assign this issue to you) and then propose a PR for this.
@AHB102 feel free to reassign it to you again in case you want to continue your work on it.
/unassign @AHB102
HI @creydr, I would Like to contribute to this issue, too. For now, I am assigning it to myself. @0ZeKa0, we can work together on this issue if you like. If there is a problem, you can unassign me.
/assign
https://github.com/knative/docs/assets/121049907/a79ceb99-cf18-4307-8172-ef65ed2ee057
Hello, @creydr @aliok I've examined the documentation and added a few more information to enhance broker developer configuration options. This is how the page looks.
Hello @0ZeKa0, thanks a lot for your work on this. I commented on your PR. Btw: for the docs repo there is a preview generated too (e.g. https://deploy-preview-5993--knative.netlify.app/docs/eventing/brokers/broker-developer-config-options/ for your PR). Usually you can find them in the comments from the netlify bot (https://github.com/knative/docs/pull/5993#issuecomment-2128121716))