docs: #1762 Added the community info and links to documentation guides and removed the sponsor part. #1770

Sonalilipsa17375 · 2025-03-06T15:27:06Z

Description

Added Community links .
Provided guide to Docs contribution links.
Removed Sponsor part as suggested.

Before - >>

After - >>

fixes: #1762

Related issue(s) - Link to the issue - #1762

github-actions

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Sonalilipsa17375 · 2025-03-07T16:21:20Z

@thulieblack I made the changes as suggested by you in #1762 , Could you please let me know if any improvement is needed .

thulieblack

@Sonalilipsa17375, great start.

Regarding the community repo and documentation, yes, I did point it out to the Community onboarding docs.

But I would like to see documents like Governance. MD, Charter. MD, and Community Goals file, which highlight the community organization and how we do things.

I hope this will provide some clarity

thulieblack · 2025-03-11T09:05:15Z

README.md

+
+- Read the [AsyncAPI Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).
+- Go through the [AsyncAPI Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md).
+- Join our [AsyncAPI Docs Community](https://www.asyncapi.com/docs/community).


We don't have a docs community but docs is part of the community

Thanks for the suggestions, I have incorporated this change.

thulieblack · 2025-03-11T09:06:16Z

README.md

+- Go through the [AsyncAPI Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md).
+- Join our [AsyncAPI Docs Community](https://www.asyncapi.com/docs/community).
+- Add the AsyncAPI calendar from the [AsyncAPI events](https://www.asyncapi.com/community/events) page to stay updated on meetings and events.
+- Review the list of [technical writer contributor](https://www.asyncapi.com/docs/community/onboarding-guide/technical-writer-contributor-responsibilities) responsibilities to understand your role.


Only one link to TW onboarding is needed here. Community repo is not only for docs

Yes updated it.

thulieblack · 2025-03-11T09:06:33Z

README.md

+    - Tutorials (take time to go through each tutorial)
+    - Reference
+- Set up your local environment following the [AsyncAPI git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md).
+- Introduce yourself in AsyncAPI Slack in the **#01_introductions channel** and the #13_docs channel. Ask docs-related questions in #13_docs.


This is not needed

thulieblack · 2025-03-11T09:07:13Z

README.md

+    - Reference
+- Set up your local environment following the [AsyncAPI git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md).
+- Introduce yourself in AsyncAPI Slack in the **#01_introductions channel** and the #13_docs channel. Ask docs-related questions in #13_docs.
+- Request a good first docs issue in the **#13_docs** [Slack channel](https://asyncapi.slack.com/ssb/redirect).


Same here, this is a community repo so it should reflect important community docs not for tech writers

I have modified it, pls share your suggestions. @thulieblack

Sonalilipsa17375 · 2025-03-13T12:31:23Z

@thulieblack Can you pls rereview it, I have incorporated the changes you have suggested and also made many design changes.

Sonalilipsa17375 · 2025-03-18T16:15:08Z

Hey @thulieblack,
Hope you're doing well! Just a gentle nudge on my PR whenever you find time. No rush, and thanks in advance! 😊

thulieblack · 2025-03-24T16:23:25Z

cc @TRohit20

TRohit20

My only skeptic would be to double check on the click backs and hyperlinks to ensure they work as expected. The rest looks good to me, please ping me after assuring for final review. Thank you

TRohit20 · 2025-03-27T04:20:31Z

README.md

+
+   - ### Getting Started
+      - **Spec Contribution:** [AsyncAPI Spec Guide](https://github.com/asyncapi/spec/blob/master/CONTRIBUTING.md)
+      - **Tools Contribution:** [AsyncAPI Tools Guide](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md)


Do we wanna include only Spec and Tools contribution here? @thulieblack

No this section we should remove

Sonalilipsa17375 · 2025-03-29T14:44:45Z

My only skeptic would be to double check on the click backs and hyperlinks to ensure they work as expected. The rest looks good to me, please ping me after assuring for final review. Thank you

Links are working fine, as reviewed from my side. @TRohit20 If anything's required kindly suggest , I can implement those.
Thanks for the review.

thulieblack

Great start, @Sonalilipsa17375. Some sections need to be removed, and others can be combined into one. The goal is to make the ReadMe simple but detailed.

thulieblack · 2025-04-02T09:16:56Z

README.md

+---
+
+## Community Goals 🎯
+Join us in 2025 as we boost maintainers, streamline onboarding, and create a structured Community Working Group Umbrella. Let's grow together through exciting initiatives like the AsyncAPI Grant Program, conferences, and mentorship. <br>


This section changes and relies on the community goals that change each year. Rather, make it dynamic

thulieblack · 2025-04-02T09:18:29Z

README.md

+└───────────────────────────────┘
+```
+---
+## Community Documentation 📚


This section should instead be part of the contributing section

thulieblack · 2025-04-02T09:19:10Z

README.md

+3. **Pick an Issue**: Choose an issue to work on and leave a comment introducing yourself. Feel free to ask questions if you're unsure how to get started.
+4. **Open a PR**: If no work has been done on the chosen issue, open a PR and start contributing!
+
+### Technical Writer Onboarding ✍️


Put everything related to onboarding under one section

thulieblack · 2025-04-02T09:19:26Z

README.md

+---
+## Our Charter 📜
+
+The **[Async API Charter](./CHARTER.md)** outlines the structure, responsibilities, and procedures for contributions and oversight of the AsyncAPI open project. <br>


Suggested change

The **[Async API Charter](./CHARTER.md)** outlines the structure, responsibilities, and procedures for contributions and oversight of the AsyncAPI open project. <br>

The **[AsyncAPI Charter](./CHARTER.md)** outlines the structure, responsibilities, and procedures for contributions and oversight of the AsyncAPI open project. <br>

thulieblack · 2025-04-02T09:19:49Z

README.md

+
+---
+
+## Community Governance 🏛️


Remove this section we are having a governance board soon

thulieblack · 2025-04-02T09:21:29Z

README.md

+
+---
+
+## Async API Technical Steering Committee (TSC) 👥


Make the TSC and Ambassador sections into one. Maybe rename to "Becoming a TSC or an AsyncAPI Ambassador"

thulieblack · 2025-04-02T09:22:03Z

README.md

+
+AsyncAPI Community uses **Slack as the source of communication**. It helps us stay closer to each other and to know each other better through discussions.
+
+ For more details, refer to our **[Slack Etiquette](./slack-etiquette.md)** guidelines.


This should also go under contributing or getting started.

thulieblack · 2025-04-02T09:23:38Z

README.md

+
+## Community Discussions 💬
+
+AsyncAPI Community uses **Slack as the source of communication**. It helps us stay closer to each other and to know each other better through discussions.


Actually, Slack isn't the only form of communication. Maybe it can be something to add in the beginning of the page under welcome.

thulieblack · 2025-04-02T09:24:09Z

README.md

+
+  ### Need Help? 🤝
+
+  If you have any questions or need guidance, feel free to reach out through our **[Community Discussions](https://asyncapi.com/slack-invite)**.


Github discussions link shouldn't take you to slack

Sonalilipsa17375 requested review from quetzalliwrites, derberg, asyncapi-bot-eve and thulieblack as code owners March 6, 2025 15:27

github-actions bot reviewed Mar 6, 2025

View reviewed changes

Sonalilipsa17375 mentioned this pull request Mar 6, 2025

[📑 Docs]: update Community Readme.md #1762

Open

1 task

Sonalilipsa17375 changed the title ~~fix: #1762 Added the community info and links to documentation guides and removed the sponsor part.~~ docs: #1762 Added the community info and links to documentation guides and removed the sponsor part. Mar 9, 2025

thulieblack requested changes Mar 11, 2025

View reviewed changes

Sonalilipsa17375 added 9 commits March 13, 2025 12:23

removed chnages suggested

39565f4

removed sponsors list and added community info and links

2a2eee2

removed sponsor part and added community info and links

61ab6ae

changes

3c40df0

final changes

f9ddc95

final

12c5237

final

1511e8c

final

1a72693

changes

888dbcc

Sonalilipsa17375 force-pushed the readmeupdate branch from 5214fbb to 888dbcc Compare March 13, 2025 06:53

Sonalilipsa17375 and others added 3 commits March 13, 2025 12:32

universal link

f94df3a

changes fixed, added governance, charter, tsc, and ambassador contents

342e731

Merge branch 'asyncapi:master' into readmeupdate

8272cb1

Merge branch 'master' into readmeupdate

3003e18

Sonalilipsa17375 requested a review from thulieblack March 18, 2025 16:15

Merge branch 'master' into readmeupdate

da2cace

TRohit20 reviewed Mar 27, 2025

View reviewed changes

Sonalilipsa17375 and others added 2 commits March 29, 2025 20:15

Merge branch 'master' into readmeupdate

b0bc77d

Merge branch 'master' into readmeupdate

327abf4

thulieblack reviewed Apr 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: #1762 Added the community info and links to documentation guides and removed the sponsor part. #1770

docs: #1762 Added the community info and links to documentation guides and removed the sponsor part. #1770

Sonalilipsa17375 commented Mar 6, 2025 •

edited

Loading

github-actions bot left a comment

Sonalilipsa17375 commented Mar 7, 2025

thulieblack left a comment

thulieblack Mar 11, 2025 •

edited

Loading

Sonalilipsa17375 Mar 13, 2025

thulieblack Mar 11, 2025

Sonalilipsa17375 Mar 13, 2025

thulieblack Mar 11, 2025

thulieblack Mar 11, 2025

Sonalilipsa17375 Mar 13, 2025

Sonalilipsa17375 commented Mar 13, 2025

Sonalilipsa17375 commented Mar 18, 2025

thulieblack commented Mar 24, 2025

TRohit20 left a comment

TRohit20 Mar 27, 2025

thulieblack Apr 2, 2025

Sonalilipsa17375 commented Mar 29, 2025

thulieblack left a comment

thulieblack Apr 2, 2025

thulieblack Apr 2, 2025

thulieblack Apr 2, 2025

thulieblack Apr 2, 2025

thulieblack Apr 2, 2025

thulieblack Apr 2, 2025

thulieblack Apr 2, 2025

thulieblack Apr 2, 2025

thulieblack Apr 2, 2025

	The [Async API Charter](./CHARTER.md) outlines the structure, responsibilities, and procedures for contributions and oversight of the AsyncAPI open project. <br>
	The [AsyncAPI Charter](./CHARTER.md) outlines the structure, responsibilities, and procedures for contributions and oversight of the AsyncAPI open project. <br>


		AsyncAPI Community uses Slack as the source of communication. It helps us stay closer to each other and to know each other better through discussions.

		For more details, refer to our [Slack Etiquette](./slack-etiquette.md) guidelines.


		## Community Discussions 💬

		AsyncAPI Community uses Slack as the source of communication. It helps us stay closer to each other and to know each other better through discussions.


		### Need Help? 🤝

		If you have any questions or need guidance, feel free to reach out through our [Community Discussions](https://asyncapi.com/slack-invite).

docs: #1762 Added the community info and links to documentation guides and removed the sponsor part. #1770

Are you sure you want to change the base?

docs: #1762 Added the community info and links to documentation guides and removed the sponsor part. #1770

Conversation

Sonalilipsa17375 commented Mar 6, 2025 • edited Loading

Description

Before - >>

After - >>

fixes: #1762

Related issue(s) - Link to the issue - #1762

github-actions bot left a comment

Choose a reason for hiding this comment

Sonalilipsa17375 commented Mar 7, 2025

thulieblack left a comment

Choose a reason for hiding this comment

thulieblack Mar 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sonalilipsa17375 commented Mar 13, 2025

Sonalilipsa17375 commented Mar 18, 2025

thulieblack commented Mar 24, 2025

TRohit20 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sonalilipsa17375 commented Mar 29, 2025

thulieblack left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sonalilipsa17375 commented Mar 6, 2025 •

edited

Loading

thulieblack Mar 11, 2025 •

edited

Loading