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: added Proposed Project Ideas to Mentorship Directory #1567

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion mentorship/asyncapi-mentorship/2023/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Status: In Progress
# Status: Completed

## Timeline

Expand Down
20 changes: 20 additions & 0 deletions mentorship/asyncapi-mentorship/2024/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Status: Completed

## Timeline

- Project proposals applications open: September
- Mentees applications open: September - October
- Application review by the mentors/admission decisions: September - October

Mentorship duration - Five months \(full-time schedule\)

No.| Project | Category | Mentor/s|
---|---|---|---|
1| [Enhancing Developer Experience in CLI](https://github.com/asyncapi/cli/issues/1508)| Engineering| [Souvikns](https://github.com/Souvikns) |
2| [Becoming a Maintainer of AsyncAPI Generator](https://github.com/asyncapi/generator) | Engineering| [derberg](https://github.com/derberg) |
3| [Migration of build + workflow scripts to TypeScript](https://github.com/asyncapi/website/issues/3187) | Engineering| [akshatnema](https://github.com/akshatnema) |
4| [Holopin Design Project](https://github.com/asyncapi/community/issues/1306) | Design | [@Mayaleeeee](https://github.com/Mayaleeeee) |
5| [Onboarding Contributor Guides](https://github.com/asyncapi/generator) | Documentation |[quetzalliwrites](https://github.com/quetzalliwrites) [wise4rmgod](https://github.com/wise4rmgod) [bandantonio](https://github.com/bandantonio) |
6| [Path to Maintainership for the AsyncAPI React Project](https://github.com/asyncapi/asyncapi-react) | Engineering| [AceTheCreator](https://github.com/AceTheCreator) |
7| [Integrating EDAVisualiser Application Focus View into VS Code AsyncAPI Plugin](https://github.com/asyncapi/vs-asyncapi-preview/issues/235) | Engineering| [ivangsa](https://github.com/ivangsa) |
8|[Expand AsyncAPI Community Docs](https://github.com/asyncapi/community/blob/master/docs/onboarding-guide/docs-onboarding-checklist.md) | Documentation |[quetzalliwrites](https://github.com/quetzalliwrites) [wise4rmgod](https://github.com/wise4rmgod) [bandantonio](https://github.com/bandantonio) |
14 changes: 14 additions & 0 deletions mentorship/asyncapi-mentorship/2024/project-ideas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Projects ideas

### Ideas list

Number | Idea | Area | Mentor/s| Scope |
:---:|:---:|:---:|:---:|:---:|
1| [Enhancing Developer Experience in CLI](https://github.com/asyncapi/cli/issues/1508) | Coding | [Souvikns](https://github.com/Souvikns) | Improve the AsyncAPI CLI by adding features like validating files with custom rules, syncing with remote systems, publishing to schema registries, rendering documentation, and fixing test case execution. Also, address remaining DX issues in the CLI.|
2| [Becoming a Maintainer of AsyncAPI Generator](https://github.com/asyncapi/generator) | Coding | [derberg](https://github.com/derberg) | Familiarize with the AsyncAPI Generator by setting it up locally, running tests, and improving the development guide. Complete the tutorial, provide documentation feedback, and demonstrate JavaScript skills. Previous contributions to AsyncAPI are a plus.|
3| [Migration of build + workflow scripts to TypeScript](https://github.com/asyncapi/website/issues/3187) | Coding | [akshatnema](https://github.com/akshatnema) | Migrate existing Node.js scripts to TypeScript for improved code uniformity, scalability, and maintainability. This involves setting up ts-node without altering the current Node.js setup, converting build and workflow scripts to TypeScript, ensuring compatibility with GitHub workflows, and maintaining or expanding test coverage to ensure nothing breaks during the migration process. |
4| [Holopin Design Project](https://github.com/asyncapi/community/issues/1306)| Design | [Mayaleeeee](https://github.com/Mayaleeeee) | In this project, you'll be designing digital badges for AsyncAPI, ensuring they’re visually appealing and fit within our branding. Familiarize yourself with Figma (or similar tools), grasp basic design principles, and understand branding.|
5| [Onboarding Contributor Guides](https://github.com/asyncapi/generator) | Docs |[quetzalliwrites](https://github.com/quetzalliwrites) [wise4rmgod](https://github.com/wise4rmgod) [bandantonio](https://github.com/bandantonio) | The goal is to enhance the onboarding process by developing clear, structured, and automated guides, ensuring new contributors can efficiently integrate into the project. This will include written guides and media resources like YouTube videos to simplify the journey for each role. |
6| [Path to Maintainership for the AsyncAPI React Project](https://github.com/asyncapi/asyncapi-react) | Coding | [AceTheCreator](https://github.com/AceTheCreator) | The AsyncAPI React component is essential for rendering and validating API documentation based on the AsyncAPI specification, with over 5 million downloads. This project aims to revitalize its development by onboarding a new maintainer to work on bug fixes, UX improvements, feature additions, issue triaging, and engaging contributors. The focus is on maintaining and improving the component while mentoring a passionate individual who is familiar with TypeScript, React, and open-source contributions |
7| [Integrating EDAVisualiser Application Focus View into VS Code AsyncAPI Plugin](https://github.com/asyncapi/vs-asyncapi-preview/issues/235) | Coding | [ivangsa](https://github.com/ivangsa) | Enhance the VS Code AsyncAPI[asyncapi/vs-asyncapi-preview](https://github.com/asyncapi/vs-asyncapi-preview/issues/235) Plugin by adding EDAVisualiser's[EDAVisualiser](https://github.com/asyncapi/EDAVisualiser) application focus view. This new feature will allow users to visualize how an application interacts with other defined applications. The project involves integrating the EDAVisualiser library, implementing a configuration system for related AsyncAPI documents, and creating a user interface to switch between preview modes. Skills required include JavaScript/TypeScript, VS Code extension development, and AsyncAPI knowledge. |
8| [Expand AsyncAPI Community Docs](https://github.com/asyncapi/community/blob/master/docs/onboarding-guide/docs-onboarding-checklist.md) | Docs | [quetzalliwrites](https://github.com/quetzalliwrites) [wise4rmgod](https://github.com/wise4rmgod) [bandantonio](https://github.com/bandantonio) | This project focuses on enhancing the AsyncAPI community documentation by automating the onboarding process and documenting workflows for contributors, maintainers, ambassadors, and governance. The goal is to streamline contributions, encourage participation, and provide clear guidelines for various roles. The project involves documenting contribution flows, Git workflows, maintainership guidelines, and community health standards. The maintainership goal includes onboarding a dedicated docs triage to help manage and update these critical community processes.|
1 change: 1 addition & 0 deletions mentorship/asyncapi-mentorship/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ The AsyncAPI Mentorship makes it easy to sponsor and help train the next generat
## Program Cycles and Archive data
| Year | Term | Status | Announcement | Details |
| ---- | ------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| 2024 | Sept-Jan | In Progress | | [Sept-Jan](2024/README.md)|
| 2023 | Jan-Nov | Completed | | [Jan-Nov](2023/README.md) |
| 2022 | Jan-Nov | Completed | | [Jan-Nov](2022/README.md) |

Expand Down
Loading