website icon indicating copy to clipboard operation
website copied to clipboard

[📑 Docs]: NEW streetlights tutorial diagram

Open quetzalliwrites opened this issue 3 years ago • 5 comments

What Dev Docs changes are you proposing?

Our Streetlights tutorial would benefit from having a diagram to illustrate what we're building.

This issue can be completed AFTER the community has voted and agreed on technology to use for our diagrams via https://github.com/asyncapi/website/issues/849.

Code of Conduct

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

quetzalliwrites avatar Jun 30 '22 02:06 quetzalliwrites

@starlightknown go ahead and add your diagram to this ticket and keep an eye on when you can update the tutorial with it.

Besides creating a PR to get a technical review on your diagram, we need to wait and confirm via https://github.com/asyncapi/website/issues/849 what tool we're using for diagrams.

quetzalliwrites avatar Jun 30 '22 02:06 quetzalliwrites

Yep, thank you!

starlightknown avatar Jun 30 '22 05:06 starlightknown

mermaid-diagram-20220621114613

starlightknown avatar Jul 01 '22 02:07 starlightknown

Hey @starlightknown do you happen to have a MermaidJS LIVE editor link to the markdown diagram you created for this one?

We want to actually have the markdown for this vs only the imported png file because if we go the MermaidJS route, we want this ticket to include all markdown to recreate it 😄

quetzalliwrites avatar Jul 06 '22 02:07 quetzalliwrites

Hey @starlightknown do you happen to have a MermaidJS LIVE editor link to the markdown diagram you created for this one?

We want to actually have the markdown for this vs only the imported png file because if we go the MermaidJS route, we want this ticket to include all markdown to recreate it smile

yes here


classDiagram MQTT <.. Streetlight1 : publish light/measured MQTT <.. Streetlight2 : publish light/measured MQTT <.. Streetlight3 : publish light/measured MQTT ..> Application: subscribe light/measured 1,2,3

class Streetlight1{
  +int lumens: 3
  +String id()
  +String sentAt()
}
class Streetlight2{
  +int lumens: 3
  +String id()
  +String sentAt()
}
class Streetlight3{
  +int lumens: 3
  +String id()
  +String sentAt()
}

starlightknown avatar Jul 06 '22 03:07 starlightknown

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Nov 04 '22 00:11 github-actions[bot]