website icon indicating copy to clipboard operation
website copied to clipboard

[📑 Docs]: new producer concept doc

Open quetzalliwrites opened this issue 2 years ago • 3 comments

What Dev Docs changes are you proposing?

NEW /producer concept doc

As part of gsod, we need to build out the new Concepts section in our docs.

Screen Shot 2022-05-25 at 6 56 55 PM

Each concept page should be planned w/ an agnostic outline

To get an idea started, perhaps the outline could be...

  • Producer definition
  • Why do we need producers?
  • Where do producers fit within AsyncAPI’s EDA architecture?

Each concept page should include at least 1 engineering diagram that helps users visualize each spec term

We'll team with design contributors such as @mcturco (current core maintainer design contributor) for this step.

It's the TW's responsibility to first get sign-off on having a technically accurate diagram before they ask for a design contributor to help beautify it according to the AsyncAPI branding style guide.

Contributors should be able to start their rough draft of the diagram for free on FigJam.

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

quetzalliwrites avatar May 26 '22 02:05 quetzalliwrites

Here's your first gsod issue @nelsonmic! ⭐

quetzalliwrites avatar May 26 '22 02:05 quetzalliwrites

awesome, let's get to work

nelsonmic avatar May 26 '22 11:05 nelsonmic

I'll be here when you need me 😄 ✨

mcturco avatar May 26 '22 20:05 mcturco