Status: Completed

AsyncAPI Mentorship Program 2023

Welcome to the AsyncAPI Mentorship Program 2023 project ideas page! If you are an interested contributor, please don't hesitate to contact our mentors directly to discuss project ideas.

1) Add help/{command} endpoint ✅

Add a new endpoint to the AsyncAPI server API that provides detailed information and usage instructions for the CLI tool. The endpoint should return all available endpoints and particular ones like help/generate should return details about given command, similar to our main CLI.

• 🎯 Outcome: Help endpoint system that provides comprehensive CLI usage instructions and command details.
• 🛠️ Skills Required: JavaScript/TypeScript, Node.js, API development, CLI tools.
• 🧩 Difficulty: Easy/Medium
• 👩🏿‍🏫 Mentor(s): David Pereira
• 👩🏿‍🏫 Mentee: Prince Rajpoot
• ⏳ Length: 175 Hours

2) Website UI Kit design/dev project ✅

Create a comprehensive UI Kit for the AsyncAPI website to ensure design consistency and streamline development. There are many places where components need to be created for even the smallest of elements that repeat on the website.

• 🎯 Outcome: Complete UI Kit with reusable components ensuring brand consistency across the website.
• 🛠️ Skills Required: React, Design systems, Figma, Component development.
• 🧩 Difficulty: Medium
• 👩🏿‍🏫 Mentor(s): Azeez Elegbede
• 👩🏿‍🏫 Mentee: Aishat Muibudeen
• ⏳ Length: 350 Hours

3) MVP integration of extensions catalog with AsyncAPI tools ✅

Integrate the extensions catalog with AsyncAPI tools to support official extensions. People use extensions, and we should support the official ones in our tools to enhance the ecosystem.

• 🎯 Outcome: Extensions catalog integrated with AsyncAPI tools, enabling official extension support.
• 🛠️ Skills Required: JavaScript/TypeScript, AsyncAPI tools, API integration.
• 🧩 Difficulty: Medium/Hard
• 👩🏿‍🏫 Mentor(s): Lukasz Gornicki
• 👩🏿‍🏫 Mentee: Sambhav Gupta
• ⏳ Length: 350 Hours

4) Documenting how different protocols work with AsyncAPI ✅

Create comprehensive documentation and tutorials showing how different protocols work with AsyncAPI. The community uses different protocols because everyone has diverse needs, so we need more tutorials with different protocol setups.

• 🎯 Outcome: Complete documentation covering various protocols (MQTT, Kafka, AMQP, WebSocket, etc.) with AsyncAPI.
• 🛠️ Skills Required: Technical writing, AsyncAPI, various messaging protocols, tutorial creation.
• 🧩 Difficulty: Medium
• 👩🏿‍🏫 Mentor(s): Quetzalli Writes
• 👩🏿‍🏫 Mentee: Cynthia Peter | Arya Gupta | Joy Almeida | Vaishnavi Nandakumar
• ⏳ Length: 350 Hours

5) Rewrite this template and NodeJS WS template ✅

Rewrite the nodejs-template and nodejs-ws-template from the old Nunjucks templating engine to the React templating engine, which should become the default and only engine in the future.

• 🎯 Outcome: Both Node.js templates rewritten using React templating engine with full functionality.
• 🛠️ Skills Required: JavaScript/TypeScript, React, AsyncAPI Generator, templating engines.
• 🧩 Difficulty: Medium/Hard
• 👩🏿‍🏫 Mentor(s): Lukasz Gornicki
• 👩🏿‍🏫 Mentee: Kaushik Rishi
• ⏳ Length: 350 Hours

6) Simulator Desktop Application ✅

Transform the CLI application into a complete desktop application that visualizes an AsyncAPI file and allows users to generate traffic interactively.

• 🎯 Outcome: Fully functional desktop application for AsyncAPI simulation with interactive traffic generation.
• 🛠️ Skills Required: JavaScript/TypeScript, Electron, Desktop app development, AsyncAPI.
• 🧩 Difficulty: Medium/Hard
• 👩🏿‍🏫 Mentor(s): Nektarios Fifes
• 👩🏿‍🏫 Mentee: Sumant Tirkey
• ⏳ Length: 350 Hours

7) Tutorial document or separate guides for Glee ✅

Create comprehensive documentation for Glee covering installation, setup, configuration, and deployment. Currently, it is hard to get started with Glee as a new user.

• 🎯 Outcome: Complete tutorial documentation for Glee covering all aspects from setup to deployment.
• 🛠️ Skills Required: Technical writing, Glee, Node.js, AsyncAPI.
• 🧩 Difficulty: Easy/Medium
• 👩🏿‍🏫 Mentor(s): Souvik De | Khuda Dad Nomani
• 👩🏿‍🏫 Mentee: Afzal Ansari
• ⏳ Length: 175 Hours

8) Add support for translations ✅

Enable adoption of the spec to a larger group by adding translation support to the AsyncAPI website. Translation of docs was an enabler for Kubernetes and Vue, and it could be for AsyncAPI too.

• 🎯 Outcome: Multi-language support infrastructure for the AsyncAPI website with initial language translations.
• 🛠️ Skills Required: JavaScript/TypeScript, Next.js, i18n, localization.
• 🧩 Difficulty: Medium/Hard
• 👩🏿‍🏫 Mentor(s): Maciej Urbańczyk
• 👩🏿‍🏫 Mentee: Ansh Goyal
• ⏳ Length: 350 Hours

9) Prepare CLI for v1.0.0 release ✅

Prepare the AsyncAPI CLI for its first stable v1.0.0 release. Tasks include reaching 90% test coverage, enabling cross-platform installation (Windows Chocolatey), updating usage documentation with examples, and creating integration tests.

• 🎯 Outcome: AsyncAPI CLI ready for v1.0.0 release with comprehensive testing and documentation.
• 🛠️ Skills Required: JavaScript/TypeScript, Node.js, Testing, CI/CD, Documentation.
• 🧩 Difficulty: Medium/Hard
• 👩🏿‍🏫 Mentor(s): Souvik De
• 👩🏿‍🏫 Mentee: Ashish Padhy
• ⏳ Length: 350 Hours

10) DocsUI: Messages Object output ✅

Design and implement UX/UI updates to the Messages Object documentation output in the AsyncAPI React component.

• 🎯 Outcome: Improved Messages Object documentation output with enhanced UX/UI design.
• 🛠️ Skills Required: React, TypeScript, UI/UX design, Figma.
• 🧩 Difficulty: Medium
• 👩🏿‍🏫 Mentor(s): Missy Turco | Fran Méndez
• 👩🏿‍🏫 Mentee: Asmit Malakannawar
• ⏳ Length: 175 Hours

11) DocsUI: UX/UI updates

Implement UX/UI updates to the documentation components including sidebar navigation and Servers Object output.

• 🎯 Outcome: Enhanced documentation components with improved navigation and visual design.
• 🛠️ Skills Required: React, TypeScript, UI/UX design, Component development.
• 🧩 Difficulty: Medium
• 👩🏿‍🏫 Mentor(s): Missy Turco | Fran Méndez
• ⏳ Length: 175 Hours

12) Developing a Step-by-Step Contributing Guide for Newcomers

Create clear and concise instructions, documentation, and resources to streamline the onboarding process and empower new contributors to quickly make their initial contribution.

• 🎯 Outcome: Comprehensive step-by-step contributing guide for newcomers with examples and resources.
• 🛠️ Skills Required: Technical writing, Documentation, Contributor experience.
• 🧩 Difficulty: Easy/Medium
• ⏳ Length: 175 Hours

13) Integration of AsyncAPI Tools Examples within AsyncAPI Tools Dashboard Tab

Integrate setup and examples of AsyncAPI tools into the AsyncAPI Tools Dashboard page to provide users with a comprehensive overview of each tool's functionality, setup requirements, and use cases.

• 🎯 Outcome: Enhanced Tools Dashboard with integrated examples and setup guides for all AsyncAPI tools.
• 🛠️ Skills Required: JavaScript/TypeScript, React, Documentation, AsyncAPI tools.
• 🧩 Difficulty: Medium
• ⏳ Length: 175 Hours

14) Open Graph link preview image according to the document to open

Generate preview images dynamically based on the shared AsyncAPI file, showing the title, description, and some stats when Studio links are shared on social media.

• 🎯 Outcome: Dynamic Open Graph preview images for Studio links with document-specific information.
• 🛠️ Skills Required: JavaScript/TypeScript, React, Image generation, Open Graph protocol.
• 🧩 Difficulty: Medium
• ⏳ Length: 175 Hours

15) "Open with Studio" button for Markdown files

Design a button with the AsyncAPI logo that people can use for linking to AsyncAPI files in their Markdown/HTML files.

• 🎯 Outcome: Reusable "Open with Studio" button component with documentation.
• 🛠️ Skills Required: UI/UX design, HTML/CSS, Component development.
• 🧩 Difficulty: Easy
• ⏳ Length: 90 Hours

16) Enhanced Collaboration and Real-time Editing

Enhance collaboration and real-time editing capabilities within AsyncAPI Studio by adding features like conflict detection and resolution, user presence indicators, and version history.

• 🎯 Outcome: Real-time collaboration features in Studio with conflict resolution and version history.
• 🛠️ Skills Required: JavaScript/TypeScript, React, WebSockets, Real-time systems.
• 🧩 Difficulty: Hard
• ⏳ Length: 350 Hours

17) API Development Platform Integration

Integrate AsyncAPI Studio with API development platforms to enhance the overall development experience with features like API platform integration, security/authentication, documentation generation, deployment, and testing.

• 🎯 Outcome: Studio integrated with major API development platforms with enhanced development workflow.
• 🛠️ Skills Required: JavaScript/TypeScript, API integration, OAuth, CI/CD.
• 🧩 Difficulty: Hard
• ⏳ Length: 350 Hours

18) Library for easier integration testing of code generators

Create a library or feature in Generator that enables easy integration tests for templates.

• 🎯 Outcome: Testing library for AsyncAPI Generator templates with comprehensive documentation.
• 🛠️ Skills Required: JavaScript/TypeScript, Testing frameworks, AsyncAPI Generator.
• 🧩 Difficulty: Medium/Hard
• ⏳ Length: 350 Hours

19) Enable Metric Monitoring and Observability Modules for Code Generators

Develop a feature allowing users to quickly accommodate a metric monitoring module within their generated applications.

• 🎯 Outcome: Metric monitoring and observability module integrated into AsyncAPI code generators.
• 🛠️ Skills Required: JavaScript/TypeScript, Monitoring systems, Observability, AsyncAPI Generator.
• 🧩 Difficulty: Hard
• ⏳ Length: 350 Hours

20) Drag & drop AsyncAPI block builder

Add the ability to create AsyncAPI specifications from scratch (or update existing ones) using drag and drop blocks in Studio, similar to the current read-only visualizer.

• 🎯 Outcome: Interactive drag-and-drop editor for creating and modifying AsyncAPI specifications.
• 🛠️ Skills Required: JavaScript/TypeScript, React, Drag-and-drop libraries, AsyncAPI.
• 🧩 Difficulty: Hard
• ⏳ Length: 350 Hours

21) Desktop/Native application for AsyncAPI Studio

Create a desktop application for AsyncAPI Studio to eliminate dependency on the web version and simplify the user experience.

• 🎯 Outcome: Cross-platform desktop application for AsyncAPI Studio (Windows, macOS, Linux).
• 🛠️ Skills Required: JavaScript/TypeScript, Electron, Desktop app development.
• 🧩 Difficulty: Medium/Hard
• ⏳ Length: 350 Hours

Timeline

• Project proposals applications open: April 1st - June 6th
• Mentees applications open: June 6th - June 23rd
• Application review by the mentors/admission decisions: June 23rd - July 7th

Mentorship duration - Six months (full-time schedule)

Contact AsyncAPI Mentors

• Join our Slack workspace. Observe our Slack etiquette and AsyncAPI code of conduct.
• Join the dedicated Mentorship channel #09_mentorships to meet all other mentees and mentors.

FAQ

1. How active are previous mentees in AsyncAPI? Many mentees from our 2022 programs remain actively involved in the community. You can view detailed retention statistics on our Mentorship Programs Insights page.

2. What is the time commitment for mentees? Projects range from 90 to 350 hours depending on scope and complexity. This typically translates to 10-20 hours per week over 3-6 months.

3. Can I apply for multiple projects? Yes, but we recommend focusing on one project that aligns best with your skills and interests to ensure quality contributions.

4. Where is the AsyncAPI source code located? You can find all AsyncAPI source code on GitHub under our organization: https://github.com/asyncapi.

If you have further questions or queries, please create an issue in this /community repo (with the prefix Mentorship 2023) or start an open AsyncAPI discussion.