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: add docs community section to onboarding guide #959

Merged
merged 9 commits into from
Jan 20, 2024
53 changes: 53 additions & 0 deletions docs/onboarding-guide/docs-community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# AsyncAPI docs community

## Open docs community meetings

We host regular community meetings via Zoom where we discuss topics relating to the AsyncAPI initiative. All the meetings are livestreamed on our social media channels.

### Join docs meetings

- Add the AsyncAPI calendar to your [Google Calendar](https://calendar.google.com/calendar/u/3?cid=Y19xOXRzZWlnbG9tZHNqNm5qdWh2YnB0czExY0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t) or download the [ICS file](https://calendar.google.com/calendar/ical/c_q9tseiglomdsj6njuhvbpts11c%40group.calendar.google.com/public/basic.ics) to stay informed about upcoming meetings and calls.

- If you're interested in the `spec` docs, join the dedicated **Spec 3.0 Docs** calls held bi-weekly every Thursday.

- You can also find [upcoming and past meetings details](https://www.asyncapi.com/community/events) on the events page.

### Watch past AsyncAPI docs meetings


Visit the [AsyncAPI YouTube channel](https://www.youtube.com/AsyncAPI) for past meetings recordings.

### Schedule docs meetings


Read our FAQ to [set up and automate your own docs meetings](https://github.com/asyncapi/community/blob/master/MEETINGS_ORGANIZATION.md).


### Docs and education community discussions

Visit the [public AsyncAPI Docs & Education discussion board](https://github.com/orgs/asyncapi/discussions/categories/docs-education) to discuss docs-related issues.


## AsyncAPI Slack workspace and docs channels


Join our documentation-specific [Slack](https://www.asyncapi.com/slack-invite) channels to meet other technical writers:

- **#13_docs:** Required for all technical writers. You will find general discussions, questions, ideas, and open `good first issues.`
- **#spec:** If you’re interested in working on `spec` related documentation, connect with Spec subject matter experts to learn more about Spec docs.
- **#tooling:** If you’re interested in working on the [tools related docs](https://www.asyncapi.com/docs/tools), join this channel.



## AsyncAPI documentation roadmap 2023

**Note:** Applications for the 2023 paid writing programs are currently closed. However, we welcome you to join us as a regular docs contributor. Stay tuned for new opportunities on our [Docs’ Community discussions](https://github.com/orgs/asyncapi/discussions/categories/docs-education) or check out the [AsyncAPI Docs Project Board](https://github.com/orgs/asyncapi/projects/12).

quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved
| Docs Roadmap | Ongoing Docs Projects | Timeline | Contribution Type |
|--------------|-----------------------|----------|---------------------|
| [GSOD (Google Season of Docs)](https://developers.google.com/season-of-docs/docs/timeline) | [Documenting AsyncAPI document sections in detail. Creating a 100-level interactive learning path.](https://github.com/asyncapi/website/issues/1507) | Currently closed | Paid |
| [AsyncAPI 2023 Mentorship Program](https://github.com/orgs/asyncapi/discussions/689) | Documenting how various protocols work with AsyncAPI specification. | Currently closed | Paid |
| Spec 3.0 Docs Updates | [Spec 3.0 Docs](https://github.com/asyncapi/website/issues/1433) updates | Ongoing | Regular contribution |
| Create AsyncAPI StyleGuide | [AsyncAPI Style Guide](https://github.com/asyncapi/website/issues/1240) | Ongoing | Regular contribution |
| AsyncAPI Tools’ Docs | <li>[Modelina Docs](https://github.com/asyncapi/modelina/tree/master/docs) </li> <li>Parser Docs </li> <li>GitHub Actions Docs</li> <li>Studio Docs</li> <li>Generator Docs</li> <li>CLI Docs</li> | Ongoing | Regular contribution |
| Docs Onboarding Guide | Onboarding Guide for technical writers | Ongoing | Regular contribution |
Loading