Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adding document for Adding messages page #2025

Closed
wants to merge 10 commits into from

Conversation

mhmohona
Copy link
Contributor

@mhmohona mhmohona commented Aug 3, 2023

Description
Added Adding Messages page.

It is a part of GSoD'23 project.

Related issue(s):
fixes #1514

@netlify
Copy link

netlify bot commented Aug 3, 2023

Deploy Preview for shimmering-choux-eb0798 ready!

Name Link
🔨 Latest commit 1c25232
🔍 Latest deploy log https://app.netlify.com/sites/shimmering-choux-eb0798/deploys/64f6b1a78d4c320008344abe
😎 Deploy Preview https://deploy-preview-2025--shimmering-choux-eb0798.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@AnimeshKumar923 AnimeshKumar923 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've made some suggestions. Please have a look and provide your thoughts/feedback on it.
@mhmohona

Copy link
Member

@fmvilas fmvilas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some comments. I'm not fully aware of the GSoD issues and their context. I need @alequetzalli to provide a bit of guidance here first.

pages/docs/concepts/asyncapi-document/adding_messages.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/adding_messages.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/adding_messages.md Outdated Show resolved Hide resolved
@quetzalliwrites quetzalliwrites added 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. gsod This label should be used for issues or discussions related to ideas for Google Season of Docs labels Sep 1, 2023
Copy link
Member

@fmvilas fmvilas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another round of reviews :) Keep pushing! Specifically, I have concerns with having so many diagrams trying to explain things that may not need a diagram at all.

pages/docs/concepts/asyncapi-document/adding-messages.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/adding-messages.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/adding-messages.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/adding-messages.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/adding-messages.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/adding-messages.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/adding-messages.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/adding-messages.md Outdated Show resolved Hide resolved
pages/docs/concepts/asyncapi-document/adding-messages.md Outdated Show resolved Hide resolved
Comment on lines +102 to +118
```mermaid
flowchart TB

subgraph Components Object
Component_1
Component_2
Component_3
end

subgraph API
API_implementation --> Component_1:Uses
API_implementation --> Component_2:Uses
API_implementation --> Component_3:Uses

style API_implementation fill:#47BCEE,stroke:#47BCEE;
end
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm confused by this diagram. What exactly did you try to convey here? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to explain the reusing components section here. Do you think I should change it? In what way it would be better in your opinion?

@mhmohona mhmohona requested a review from fmvilas October 13, 2023 09:07
Copy link
Member

@fmvilas fmvilas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@derberg derberg deleted the branch asyncapi:next-major-spec December 5, 2023 09:40
@derberg derberg closed this Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs gsod This label should be used for issues or discussions related to ideas for Google Season of Docs
Projects
Status: Community PR under Review 🧐
Development

Successfully merging this pull request may close these issues.

5 participants