Brokers Documentation alignment Proposal

[salaboy]

Problem For an end-user: Developer or Operator it is quite hard to compare different Broker implementations. Now that the docs include the RabbitMQ and Kafka broker pages, it will be great to align the section of both pages and also the requirements for the repositories that contain the source code and some extra docs.

Persona: Which persona is this feature for? System Operator, System Integrator and Contributor

Exit Criteria

A user can look at both documentation pages and compare them, understand each implementation maturity level and have a clear understanding of where to find different pieces of information, such as installation procedure, contributing back to the project, etc. The source code repositories share the same directory structure and md files targeting different personas and guidelines.

Time Estimate (optional): How many developer-days do you think this may take to resolve?

TBD

Additional context (optional) Here is a document that I am using to gather feedback about the requirements and to define the structure that each implementation should follow. If we manage to define this structure, new Broker implementations can follow the same approach instead of starting from scratch.

https://docs.google.com/document/d/1dagRH-EnxYg7ru_Qmea9o5cOObB4Df64bwUtZZbfM6E/edit?usp=sharing

[salaboy]

@snneji Samia, is there something already happening around this topic?

[salaboy]

Also related: https://docs.google.com/document/d/1mFY2QdXUvhCORyVkhJtBOqWeYGOIxmJ-ltSPXWZRU3E/edit#heading=h.9pt7qa7d30fo

[snneji]

Hi @salaboy, I don't think there is currently anything happening around brokers specifically. However, there is a proposal about stadardising sandbox and add-ons that could be similar here.

This proposal for brokers sounds like a good project to improve the consistency of the docs.

[snneji]

I've put this on the agenda to talk about at tomorrow's docs working group meeting.

[salaboy]

Can we do a catch up later this week about this topic? I don't think that I will be able to join the working group meeting.

[github-actions[bot]]

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.