Skip to content

Commit

Permalink
docs: added Proposed Project Ideas to Mentorship Directory (#1567)
Browse files Browse the repository at this point in the history
Co-authored-by: Arpit Kuriyal <[email protected]>
Co-authored-by: Cody's Dad <[email protected]>
Co-authored-by: V Thulisile Sibanda <[email protected]>
  • Loading branch information
3 people authored Mar 11, 2025
1 parent 711e200 commit e7b90ee
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 4 deletions.
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
7 changes: 4 additions & 3 deletions mentorship/asyncapi-mentorship/2024/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Timeline

- Project proposals applications open: August 30th - October 2nd
- Project proposal applications open: August 30th - October 2nd
- Mentees applications open: October 10th - October 24th
- Application review by the mentors/admission decisions: October 24th - November 4th

Expand All @@ -15,8 +15,9 @@ Mentorship duration - 12 to 18weeks \(full-time schedule\)
| 2 | [Becoming a Maintainer of AsyncAPI Generator](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10520123) | [Lukasz Gornicki](https://github.com/derberg) | Engineering | [Mohan Kumar](https://github.com/ItshMoh) |
| 3 |[Migration of build + workflow scripts to typescript](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10524236) | [Akshat Nema](https://github.com/AKSHATNEMA) | Engineering | [Zeel Rajodiya](https://github.com/JeelRajodiya) |
| 4 |[Holopin Design Project](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10529752) | [Aishat Muibudeen](https://github.com/Mayaleeeee) | Design | [Olumide](https://github.com/Oloso-surur) |
| 5 |[Onboarding Contributor Guides](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10610947) | [Quetzalli](https://github.com/quetzalliwrites) [Nwokocha Wisdom Maduabuchi](https://github.com/wise4rmgod) [Antonio](https://github.com/bandantonio) | Docs | [Anushka Saxena](https://github.com/SaxenaAnushka102), [Aahil](https://github.com/Aahil13), [Ezinne Anne Emilia](https://github.com/ezinneanne) |
| 5 |[Onboarding Contributor Guides](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10610947) | [Thulisile Sibanda](https://github.com/thulieblack), [Anton](https://github.com/bandantonio) | Docs | [Anushka Saxena](https://github.com/SaxenaAnushka102), [Aahil](https://github.com/Aahil13), [Ezinne Anne Emilia](https://github.com/ezinneanne) |
| 6 |[Path to Maintainership for the AsyncAPI React Project](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10811342) | [AceTheCreator](https://github.com/acethecreator) | Engineering | [Mohammed Mehdi](https://github.com/catosaurusrex2003) |
| 7 |[Integrating EDAVisualiser Application Focus View into VS Code AsyncAPI Plugin](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10540858) | [Iván García Sainz-Aja](https://github.com/ibishal) | Engineering | [Milan D Vijay](https://github.com/ibishal)|
| 8 |[Expand AsyncAPI Community Docs](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10818908) | [Quetzalli](https://github.com/quetzalliwrites) [Nwokocha Wisdom Maduabuchi](https://github.com/wise4rmgod) [Antonio](https://github.com/bandantonio) | Docs | [Anushka Saxena](https://github.com/SaxenaAnushka102), [Aahil](https://github.com/Aahil13), [Ezinne Anne Emilia](https://github.com/ezinneanne) |
| 8 |[Expand AsyncAPI Community Docs](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10818908) | [Thulisile Sibanda](https://github.com/thulieblack), [Anton](https://github.com/bandantonio) | Docs | [Anushka Saxena](https://github.com/SaxenaAnushka102), [Aahil](https://github.com/Aahil13), [Ezinne Anne Emilia](https://github.com/ezinneanne) |


13 changes: 13 additions & 0 deletions mentorship/asyncapi-mentorship/2024/project-ideas.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# 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.|
=======
### Ideas list

Number | Idea | Area | Lead Mentor | Scope
Expand Down
3 changes: 3 additions & 0 deletions mentorship/asyncapi-mentorship/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ The AsyncAPI Mentorship makes it easy to sponsor and help train the next generat
## Program Cycles and Archive data
| Year | Term | Status | Announcement | Details |
| ---- | ------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
docs
| 2024 | Sept-Jan | In Progress | | [Sept-Jan](2024/README.md)|
| 2024 | Sep-Mar | In Progress | | In Progress |
master
| 2023 | Jan-Nov | Completed | | [Jan-Nov](2023/README.md) |
| 2022 | Jan-Nov | Completed | | [Jan-Nov](2022/README.md) |

Expand Down

0 comments on commit e7b90ee

Please sign in to comment.