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: #1762 Added the community info and links to documentation guides and removed the sponsor part. #1770

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

Sonalilipsa17375
Copy link

Description

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

Before -
Screenshot From 2025-03-06 20-52-37

After -

Screenshot From 2025-03-06 20-54-21
Screenshot From 2025-03-06 20-54-36

fixes: #1762

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

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

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
Copy link
Author

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

@Sonalilipsa17375 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
Copy link
Member

@thulieblack thulieblack left a comment

Choose a reason for hiding this comment

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

@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


- 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).
Copy link
Member

@thulieblack thulieblack Mar 11, 2025

Choose a reason for hiding this comment

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

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

- 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.
Copy link
Member

Choose a reason for hiding this comment

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

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

- 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.
Copy link
Member

Choose a reason for hiding this comment

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

This is not needed

- 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).
Copy link
Member

Choose a reason for hiding this comment

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[📑 Docs]: update Community Readme.md
2 participants