Skip to content

Commit

Permalink
tw editorial rewrite
Browse files Browse the repository at this point in the history
  • Loading branch information
quetzalliwrites authored Jan 19, 2024
1 parent 6c09190 commit 883524a
Showing 1 changed file with 12 additions and 33 deletions.
45 changes: 12 additions & 33 deletions docs/onboarding-guide/docs-onboarding-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,19 @@ weight: 30
---
## AsyncAPI docs onboarding checklist

As an open source initiative with a global community, we ask participants to become familiar with our governance documents, community guidelines, and communication channels.
As an open-source initiative with a global community, technical writer contributors should learn about our governance documents, documentation processes, and communication channels.

## Contributor standards at AsyncAPI

Complete the following to get started as a contributor to the AsyncAPI project:
Complete in order the following onboarding tasks:

- [ ] Read the [AsyncAPI Code of Conduct](https://github.com/asyncapi/community/blob/master/CODE_OF_CONDUCT.md).
- [ ] Read the [Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md).
- [ ] Join [the AsyncAPI Slack](https://asyncapi.com/slack-invite).
- [ ] Introduce yourself in the #01_introductions channel and the #13_docs channel. Ask any docs-related questions in #13_docs.
- [ ] Join the #03_specification and #11_contributing channels.
- [ ] [Visit the events page](https://www.asyncapi.com/community/events) and then add the AsyncAPI calendar to stay updated with community events.
- [ ] Join a [Thursday docs meeting](https://www.asyncapi.com/community). This is a monthly or bi-weekly opportunity to chat with maintainers and other community members in order to understand goals, ask questions, and get help.

## Technical writing standards at AsyncAPI

Complete the following to become familiar with technical writing standards and expectations at AsyncAPI:

- [ ] Read the [AsyncAPI Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md).
- [ ] Join [the AsyncAPI Slack workspace](https://asyncapi.com/slack-invite).
- [ ] Add the AsyncAPI calendar found in [the AsyncAPI events page](https://www.asyncapi.com/community/events).
- [ ] Read the list of [technical writer contributor responsibilities](/community/onboarding-guide/technical-writer-contributor-responsibilities.md).
- [ ] Become familiar with the [AsyncAPI git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md).
- [ ] Read through and be familiar with the topics in [prerequisite knowledge](/community/onboarding-guide/prerequisite-knowledge.md).
- [ ] Become familiar with the AsyncAPI Style Guide.

## Making a contribution

Now that you're up to speed, you're ready to get fully on board by making your first contribution. To start writing for AsyncAPI, complete the following:

- [ ] [Reach out to Alejandra](https://asyncapi.slack.com/team/U02AKC14WAJ) or your onboarding buddy and ask for a good first issue to work on.
- [ ] Become familiar with the [AsyncAPI Docs Board](https://github.com/orgs/asyncapi/projects/12/views/1).
- [ ] Become familiar with docs tooling and processes.
- [ ] Set up your computer's development environment to view, edit, and publish AsyncAPI projects.
- [ ] Fork the appropriate repository and follow the git workflow.
- [ ] Start contributing to the documentation.

As always, reach out to the AsyncAPI community on Slack or open an issue on GitHub with questions or concerns. We're here to help!


- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](/community/onboarding-guide/prerequisite-knowledge.md).
- [ ] Familiarize yourself with the _work-in-progress_ [AsyncAPI Style Guide](https://github.com/asyncapi/community/pulls?q=is%3Apr+is%3Aopen+style+guide).
- [ ] Read all docs under the following content buckets: `Concepts`, `Tutorials`, `Reference`. (Take the time to go through each tutorial.)
- [ ] Set up your local environment following our instructions for 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.
- [ ] [Reach out to Quetzalli in Slack DM](https://asyncapi.slack.com/team/U02AKC14WAJ) to request a good first docs issue.
- [ ] Attend [OPEN docs meetings](https://www.asyncapi.com/community/events) to chat with other maintainers, ask docs questions, and request help on docs blockers.

0 comments on commit 883524a

Please sign in to comment.