AsyncAPI docs onboarding checklist
As an open-source initiative with a global community, technical writer contributors should learn about our governance documents, documentation processes, and communication channels.
Complete in order the following onboarding tasks:
- Read the AsyncAPI Code of Conduct.
- Read the AsyncAPI Slack etiquette.
- Join the AsyncAPI Slack workspace.
- Add the AsyncAPI calendar found in the AsyncAPI events page.
- Read the list of technical writer contributor responsibilities.
- Read and familiarize yourself with the prerequisite knowledge topics.
- Familiarize yourself with the work-in-progress AsyncAPI 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.
- Introduce yourself in AsyncAPI Slack in the
#01_introductionschannel and the#13_docschannel. Ask docs-related questions in #13_docs. - Request a good first docs issue in the
#13_docsSlack channel. - Attend OPEN docs meetings to chat with other maintainers, ask docs questions, and request help on docs blockers.
