Mentorship Program 2023: KickOff 🚀

[AceTheCreator]

Hey, Folks!!!

📣 Announcement

It's Ace, and I'm here with an important announcement.

How would you feel if I was to tell you that the AsyncAPI mentorship program is happening again this year?

Yeah, it's happening, and you don't want to miss out because this year, we are not going only to be accepting code-related projects but also design and technical writing, which means anyone can be a part of the program this year 🙂

Last year we hosted the first-ever AsyncAPI mentorship program, and out of 10 candidates, only six candidates completed their projects. I know you might wonder why; the last year's program was more of a beta test to see how things would work out or to see if it's something we should continue, and I'm glad it was a positive experience both from the mentor's side and mentees point of view. Yeah, we had some ups and downs with the participants, and we learned a lot to help us better the program in the long run.

🤨 Why do we do this?

At AsyncAPI, we value giving back to the community, as it gives us a sense of purpose as a community-first organization. We are particularly interested in doing this program again because of the unparalleled feeling of giving back and contributing to the community we've gotten from this program. As an open-source organization, we hope to collaborate with a broader reach of open-source enthusiasts and help bring more folks into the open-source world(which we are already doing). Furthermore, our reason for doing this program comes from our passion for open source and the care to support and encourage open-source contributors by building and participating in mentorships.

It's going to be an exciting year for the AsyncAPI contributors, as we will be participating in 3 mentorship programs which include GSoD, GSoC, and our own AsyncAPI Mentorship Program. If you failed to get into GSoC or GSoD, you still have a chance to participate in this year's AsyncAPI mentorship program.

🦺 Project Ideas

Have any exciting project ideas? Did your project idea get rejected for GSoC? Are you a project maintainer with exciting ideas? Submit your ideas as a GitHub issue(including the mentorship label), a separate discussion, or a comment below.

Anyone can create proposal suggestions. There is no specific template to follow, only common sense. Describe in a detailed way what it is about, what are the requirements and desired outcome. If the proposal suggestion misses some details - do not worry. We will be sure to follow up with a request for more clarification.

Project Ideas can be Engineering, Design, and Technical writing related.

We will make sure there are mentors for each proposal that gets selected because all of AsyncAPI's mentors are core members of the AsyncAPI community and prominent advocates for open-source projects with a strong belief in FOSS, which means keeping them engaged will require just a little effort. But we'll keep them engaged by staying connected and ensuring communication channels go both ways, showing how they made a difference and valuing the opinions of every mentor.

Project Ideas Deadline

The deadline for project ideas submission is four(4) weeks after the program announcement.

⏳ Timeline

The AsyncAPI mentorship program will take approximately 4-6 months, depending on the complexity of each project. Here's a sneak peek at the timeline milestone

• April - May: Project ideas submission and ranking
• June: Program application opens for three weeks, and selected candidates will be announced on the 4th week
• July - September: First Phase of the program commences
• September: First Evaluation period
• October - December: Second Phase of the program commences
• December: Final Evaluation period

💸 Project Budget

Like last year, there will only be ten slots available for this year's program at the cost of $1,500 per candidate, which is a total of $15,000.

🧾 Payment Method

Selected candidates will receive a stipend of $1,500 for participating in the program, and candidates are only allowed to request payment via Open Collective by submitting an expense.

Payments are only made to candidates who pass an evaluation phase; for each successful evaluation phase, you receive half the total amount—more on the program rules and guidelines coming soon.

📱 How to connect with us

• Join our Slack workspace. Just make sure to follow our Slack etiquette and the code of conduct.
• Join the dedicated Mentorship channel #mentorships that we will use to coordinate the application process until program starts. All mentees and mentors are there.

Feel free to share with your peers 🙂

Q&A

This program information page is published as a GitHub Discussion to enable you to ask questions 👇🏼 in case something is not clear, and we will follow up by updating this post with more clarification.

Peace ☮️ ✌🏾

cc @asyncapi/tsc_members @derberg @alequetzalli @thulieblack @fmvilas @Barbanio

[derberg]

@AceTheCreator not sure why but there was no notification sent to TSC members -> https://github.com/asyncapi/community/actions/runs/4791729095/jobs/8522465648

probably some special sing or something in the text. We probably need better escaping of content, dunno 🤷🏼

anyway pinging TSC again

@asyncapi/tsc_members folks please have a look 🙏🏼 AsyncAPI Mentorship starts again, we need proposals for projects

[NektariosFifes]

I created an issue with my proposal regarding the simulator repository. #691 (comment). I will add further details.

[Savio629]

Mentorship Program 2023 : Developing a Step-by-Step Contributing Guide for Newcomers [Project Idea]⭐

Description:

First of all, why do we need a contributing guide? When I started contributing to AsyncAPI, I had no prior knowledge about event-driven architectures, and had only a slight understanding of APIs. Consequently, I realized that I wouldn't be able to contribute effectively to the community. However, I took my first step by drafting a design for Dark mode of Async Website (Figma) which eventually led to my involvement in contributing to the AsyncAPI website. Subsequently, I delved deeper into other projects within AsyncAPI and applied for GSOC 2023. Despite taking me a week to understand the issue and project, I didn't lose hope and applied for the project. As a result, I am now an upcoming mentee for AsyncAPI under Postman.
Just imagine if I hadn't taken that first step. 👀

The goal of this project is to create an exceptional and comprehensive contributing guide to reduce the time it takes for newcomers to make their first contribution to the project. By providing clear and concise instructions, documentation, and resources, we aim to streamline the onboarding process and empower new contributors to quickly and successfully make their initial contribution.

Below are some suggestions for the expected outcomes and approach. 🧾

Expected outcomes: 💬

• Developing a well-structured and user-friendly contributing guide that covers all essential aspects, including setting up the development environment, understanding the project architecture, navigating through the contribution process for drafting a design or to contribute to the docs.

• Creating detailed documentation that outlines the project's coding standards, best practices, and guidelines for submitting contributions, along with examples and reference materials.

• Designing an interactive tutorial or walkthrough to help new contributors familiarize themselves with the project's codebase and provide hands-on guidance for their first contribution while emphasing on joining slack for better communication.

Approach: 📖

• Research and analysis: Reviewing existing documentation, contributing guides, and onboarding experiences to identify pain points and areas of improvement.

• Content creation: Crafting clear and concise instructions, tutorials, and examples that cater specifically to newcomers. Ensuring that the guide is accessible to individuals with varying levels of technical expertise.

• Collaboration with the community: Engaging with existing contributors and community members to gather insights, feedback, and additional resources for the guide.

• Iterative development: Releasing the guide in stages, seeking feedback, and continuously improving and expanding the content based on user input and evolving project needs.

P.S. This project idea is also included in the AsyncAPI roadmap.😉
https://www.asyncapi.com/roadmap

In conclusion, developing a step-by-step contributing guide for newcomers has the potential to greatly benefit the AsyncAPI community. By providing clear instructions and resources, we can empower new contributors to make their initial contributions with ease. It's important to note that this project idea is currently in the proposal stage and has not yet been selected for the mentorship program. However, I believe that implementing this project would foster a more inclusive and supportive community, enabling individuals with varying levels of experience to contribute effectively to AsyncAPI.🚀💜

[akshatnema]

I submit the following project idea present inside the AsyncAPI website for the Mentorship program :

asyncapi/website#89 (comment)

[akshatnema]

Hey @AceTheCreator @thulieblack, I'm retracting this project idea from the Mentorship program as we already got a PR asyncapi/website#1368 related to this issue. So, the basis of call between me and @derberg, we thought of first resolving the issue with the current open PR.

[imvisp]

Hello 👋

I would love to know more about how can I take part in this program for writing opportunity 😃 ?

Thank you :)

[quetzalliwrites]

We'll conduct interviews for all interested writing applicants soon! :)

[ShubhamAXS19]

will you announce the dates for the interview on Slack channel ?

[quetzalliwrites]

Yes! 👍🏽

[quetzalliwrites]

Yes! 👍🏽

[quetzalliwrites]

For the technical writers, I submit assigning documenting how different protocols work with AsyncAPI. The community already voted and expressed their interest, as you can see from the previous link I added here. (The other core needs of AsyncAPI document pieces and interactive learning are already covered by our 2023 GSoD writers.)

[asmitbm]

Is this issue #4 still valid? I would like to continue working on this and create a proposal

[AceTheCreator]

Hey @asmitbm, this project was part of last year's mentorship program but got stalled due to an unforeseen circumstance. So it will be selected as part of this year's project ideas because the selected mentee is still available :)

[RP2025]

How can I start contributing?
I am new to open sources and got rejected for GSoC. I have a proposal project ready and what to share. How i can share that?

Also is there any role for contribution of technical writer?

Thankyou

[AceTheCreator]

@RP2025 feel free to share your project proposal as a thread below :)

Also is there any role for contribution of technical writer?

Yes, you should join the #mentorships channel on Slack to get regular updates

[thulieblack]

Hi everyone we are still accepting project proposals at the present moment, once that is done we will announce the application phase. Please be sure to watch our Slack and Socials for the announcements 🤗

[VipinDevelops]

Hello @thulieblack, even though my proposal for GSoC was rejected, I am still interested in participating in an open-source program. Could you please provide me with some more information about this program, and also guide me on how to apply ?
Thank you very much.

[Nishu0]

Project Idea: [Mentorship Program 2023] Integration of AsyncAPI Tools Examples within AsyncAPI Tools Dashboard Tab (Similar to AsyncAPI Docs but like providing Docs for each Tools)🛠️🚀

Introduction🔍

AsyncAPI has become a popular specification for building asynchronous APIs. There are many tools available in the market for building and consuming AsyncAPI-based APIs. However, users face difficulty in exploring the tools and their use cases as the information is scattered across different Github pages. This project proposes integrating the setup and examples of almost every tool in the AsyncAPI Tools Dashboard page to save users' time and have all the necessary tools and requirements at one place.

Project Goal🎯

The goal of this project is to integrate the 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. This will help users understand the tools' capabilities and make an informed decision on which tool to use for their project.

Project Scope📜

The project scope includes the integration of the setup and examples of the following AsyncAPI tools into the AsyncAPI Tools Dashboard page:

• API Tracker - AsyncAPI specs
• SIO-AsyncAPI
• EventBridge Atlas
• Java AsyncAPI
• KnstEventBus
• nestjs-asyncapi
• All others tools....

Approach💻

To achieve the project goal, we will first go through the documentation of each tool and extract meaningful information, including the tools' descriptions, setup information, and usage examples. If any examples are not available, we will create short and precise examples for each tool with a fresh start. For instance, consider the example of the "nestjs-asyncapi" tool, where the user has to visit the Github page to set up the project and then another page for examples. We can provide all the essential information on the Dashboard page, including the tools' descriptions, setup information, and examples of how to use each tool.

Deliverables📦

The project deliverables will include the following:

• Integration of the setup and examples of AsyncAPI tools into the AsyncAPI Tools Dashboard page 📊
• Examples of how to use each tool 🧪
• Making a new page called "Tools Documentation" in website for providing all tools setup and examples💻

Conclusion🤝

The proposed project will help users explore AsyncAPI tools more efficiently by providing all the necessary information in one place. This will save users' time and effort in exploring the tools and their use cases. The project's success will depend on how well we can integrate the setup and examples of each tool into the AsyncAPI Tools Dashboard page.

[ayushnau]

is this done or still going. @Nishu0

[thulieblack]

For Designers these are the two projects we are proposing:

1. DocsUI: UX/UI updates asyncapi-react#617 (Excluding Messages Object Output which is the issue below)
2. DocsUI: Messages Object output asyncapi-react#618

cc @mcturco

[smoya]

• For both Engineering and Design, I want to add the following proposal: Open Graph link preview image according to the document to open studio#224
• For Design, the following: "Open with Studio" button for Markdown files. studio#218

[princerajpoot20]

AsyncAPI: Add help/{command} endpoint

Introduction

As RESTful APIs grow and encompass a wide range of functionality, it becomes increasingly important for users to easily understand and interact with the API. This project aims to enhance an existing API by adding a help endpoint that provides detailed information on the commands and sub-commands available through the API.

Project Description

The goal of this project is to add a new endpoint, /help/{command}, to an existing API. This endpoint will provide users with detailed information about the available commands and their sub-commands. Users will have the option to request information on a specific command or receive an overview of all available commands.
###Features:

• Endpoint /help providing an overview of all commands.
• Endpoint /help/{command} providing detailed information on a specific command. It will have only one endpoint, that is get(/help), it will not have something like get (/help/generate).
• Extracting and serving the documentation from a markdown file.

Methodology

Analyze and understand the existing codebase.
Set up a markdown file commands.md to store command details.
Implement the /help endpoint that reads and returns a list of commands from commands.md.
Implement the /help/{command} endpoint to extract and return information about a specific command.
Test the functionality extensively.
Document the code and update the API documentation.
Submit pull requests for review and address any feedback.

Qualifications

I have a solid background in Node.js and Express.js, which are fundamental to developing the API. My understanding of asynchronous JavaScript and RESTful principles ensures I can build efficient and scalable endpoints. My experience with Markdown, coupled with my proficiency in using parsers, will be invaluable in handling the command help content. I also have experience in using HTTP clients, such as Axios, for fetching data from GitHub and other external sources. My meticulous attention to detail and commitment to writing clean and maintainable code make me well-suited for this project.

Availability

I am fully committed to working on this project full-time during the program period, and I have no major scheduling conflicts or other obligations that would prevent me from completing the work on time. I am also highly motivated to work with my mentor and with the AsyncAPI community to ensure that the project is a success, and I am willing to go above and beyond to ensure that the endpoint meets the needs of users.
Note:

• l am open to changing the timeline according to my mentor.
• I am applying for a medium term project (175 Hours).
• A buffer time period has been kept to cope with any unexpected changes.

Conclusion

The proposed project seeks to address a common pain point for AsyncAPI users by adding a new endpoint to the AsyncAPI server API that provides detailed information and usage instructions for the tool.

Detailed Solution

Key Points:
This detailed solution aims to implement a GET /help endpoint for fetching help information for AsyncAPI commands, similar to the help functionality in AsyncAPI's main CLI.
The endpoint should be capable of fetching the command information dynamically from a GitHub repository to ensure that the information is never stale.
There will be only one endpoint that is get(/help), it will not have something like get(/help/generate), the parameter will be passed in the request body.

1. Setting Up Environment and Dependencies

Set up a development environment and relevant dependencies.
Install required libraries like Express for API creation, Axios for making HTTP requests, and Marked for Markdown to HTML conversion.

2. Implementing the GET /help Endpoint

Create a new controller, helpController, for handling requests to the /help endpoint.
Define a route handler for GET /help which will fetch the list of commands from the AsyncAPI GitHub repository.
Utilize Axios to make an HTTP GET request to the GitHub URL where the command information is stored in Markdown format.
Parse the Markdown to extract the list of commands. Use a regular expression to match lines that represent command names.
Return the list of commands as a JSON response.

3. Supporting Command Specific Help via Query Parameters

Extend the /help endpoint to accept optional query parameters, such as GET /help?command=generate.
If a command is specified, the controller should fetch and parse the Markdown file, then extract detailed information for the specific command.
Use regular expressions to match the section of the Markdown file that corresponds to the requested command.
Convert the extracted Markdown to HTML using the marked library.
Return the HTML as part of a JSON response.

4. Error Handling

Implement proper error handling for cases like failed HTTP requests or when a requested command is not found in the documentation.
Return meaningful error responses with appropriate HTTP status codes.

5. Caching

To improve performance, implement caching for the fetched Markdown documentation. This will prevent unnecessary HTTP requests for each help query.
Determine a cache expiration policy that strikes a balance between performance and freshness of the information.

6. Testing

Write unit tests to ensure the endpoint returns the expected results.
Test the endpoint with different inputs, including invalid commands.
Write integration tests to ensure that the endpoint works correctly as part of the larger application.

7. Documentation and Cleanup

Document the code and the functionality of the endpoint, including example usage.
Update the API documentation to include the new /help endpoint and its capabilities.
Refactor and clean up the code to ensure it adheres to best practices.

8. Final Review and Submission

Perform a final review of the code to ensure it meets all requirements.
Submit pull requests and address any feedback received.
Ensure that the documentation is complete and that the new endpoint is fully functional.

Thanking Note

I will look forward to every feedback from the organization members reviewing this, and would be glad to discuss/change accordingly.

[ayushnau]

hi @princerajpoot20 is it still going or done.

[princerajpoot20]

hey @ayushnau It's done.

[Shurtu-gal]

Project Idea: [Mentorship Program 2023] AsyncAPI Studio: Enhanced Collaboration and Real-time Editing

🚀 Introduction:

AsyncAPI Studio is a web-based IDE designed for working with AsyncAPI specifications. While the tool provides a solid foundation for individual developers, there is a need to enhance collaboration features and introduce real-time editing capabilities. This project aims to improve collaboration within AsyncAPI Studio by enabling multiple users to work together on AsyncAPI specifications in real-time.

💡 Project Description:

The primary focus of this idea is to enhance collaboration and real-time editing capabilities within AsyncAPI Studio. The following features can be developed:

• 🤝 Real-time Collaboration:

  • Implement real-time collaboration features, allowing multiple users to work on the same AsyncAPI specification simultaneously.
  • Enable live editing, so changes made by one user are instantly visible to others working on the specification.
  • Support real-time chat or comments to facilitate communication and collaboration among users.

• 🔄 Conflict Resolution:

  • Implement conflict detection and resolution mechanisms to handle concurrent changes made by multiple users to the same specification.
  • Provide visual indicators and notifications when conflicts occur, allowing users to resolve conflicts efficiently.

• ⏳ Version History:

  • Integrate version control capabilities within AsyncAPI Studio to track the history of specification changes.
  • Allow users to view the revision history, compare versions, and revert to previous versions if needed.
  • Enable branching and merging functionalities to facilitate collaborative workflows.

• 👥 User Presence Indicators:

  • Display user presence indicators within AsyncAPI Studio to show who else is currently active and working on the same specification.
  • Enhance collaboration by enabling users to see which parts of the specification are being modified by others in real-time.

🔧 Approach:

The approach for enhancing collaboration and real-time editing in AsyncAPI Studio could be like this

1. Integration of Real-time Collaboration Framework:

   • Select and integrate a real-time collaboration framework, such as ShareDB or Yjs, that best aligns with the requirements of AsyncAPI Studio.
   • Set up the necessary server-side infrastructure to handle real-time communication and synchronization of specification changes.
   • Implement the client-side integration of the collaboration framework, allowing multiple users to connect and collaborate within AsyncAPI Studio.

2. Real-time Editing and Conflict Resolution:

   • Enable live editing functionality, ensuring that changes made by one user are instantly visible to others working on the same specification.
   • Implement conflict detection mechanisms to identify concurrent changes made by multiple users.
   • Develop conflict resolution strategies, such as highlighting conflicting changes and providing options for users to merge or resolve conflicts.

3. Version Control and History:

   • Integrate version control functionality within AsyncAPI Studio, allowing users to track the history of specification changes.
   • Implement the ability to view revision history, compare different versions, and revert to previous versions if necessary.
   • Enable branching and merging functionalities to support collaborative workflows and branching strategies.

4. User Presence Indicators and Communication:

   • Implement user presence indicators within AsyncAPI Studio to display active users and their current editing status.
   • Enable real-time chat or comment functionality to facilitate communication and collaboration among users.
   • Provide notifications or alerts to notify users of changes made by others and to handle any collaborative actions required.

By following this approach, we aim to transform AsyncAPI Studio into a powerful collaborative platform where users can seamlessly work together on AsyncAPI specifications in real-time.I look forward to a critical review so that we can fine tune the points.

[Shurtu-gal]

• Another idea would be Project Idea: [Mentorship Program 2023] AsyncAPI Studio: API Development Platform Integration studio#620

[smoya]

@Shurtu-gal That's a very cool feature! It would be awesome to see it in a separate GH Issue in the Studio repository, so we could close asyncapi/cli#104 if it makes sense.

[Shurtu-gal]

Sure, I had already opened it asyncapi/studio#619

[KhudaDad414]

For Docs and Engineering I propose the following issue: asyncapi/glee#431

[VaishnaviNandakumar]

Project Proposal - [Mentorship Program 2023]

Enable Metric Monitoring and Observability Modules for Code Generators

Description

Metric monitoring helps collect and analyze the data generated from an application and can be vital when it comes to maintaining the progress of a system. While AsyncAPI’s current code generator produces a well-formed structure to be built on, this project proposes to develop a feature that can allow users to easily accommodate a metric monitoring module within their application.

Approach & Sample Output

To create a sample application with an expected outcome I used the java-spring-template to generate a spring boot application with Kafka’s configuration for Streetlight’s API. In this example, Prometheus is the monitoring system used to collect and store metrics.

A spring boot web project was set up using this structure with the actuator endpoint to expose the application metrics.
In Spring Boot, the Prometheus port is natively supported and can be easily integrated during configuration. Once the application starts, the metrics are available at http:https://localhost:8080/actuator/prometheus

However, customized code has to be written to expose the consumer metrics to the endpoint and this differs for other servers and brokers.

As an extended scope, this endpoint can also be used a data source in Grafana to enable data visualization.

Challenges

The implementation of the solution requires customization across two areas -

• Template - The given example made use of a spring boot web application where metric monitoring is made simple using the actuator. Even then, the web interface was something that was built on top of the existing project and wasn’t directly prebuilt from the code generator. Ways to accommodate this across different templates and languages should be explored accordingly.

• Broker/Server - The code to customize metrics and expose them to endpoints differs across the framework used. For brokers such as MQTT, the documentation was very limited.

Conclusion

This project proposal aimed to introduce a new feature that could elevate the capabilities of AsyncAPI’s code generator. Despite the challenges in its requirements, there is a lot of potential in this problem statement and I believe it will offer a whole new level to explore data in an application based on event-driven architecture.

[derberg]

For the mentorship I'd like to submit my topics that did not make it into AsyncAPI Mentorship 2022:

• Rewrite this template and NodeJS WS template to new react rendering engine nodejs-template#133
• MVP integration of extensions catalog with AsyncAPI tools to make extension catalog useful extensions-catalog#78

I think asyncapi/website#267 would also be a nifty topic to push, but I don't think I'm able to mentor it, I have to many topics. If there is any other TSC member that can mentor it, that would be amazing

[derberg]

another great one is asyncapi/generator#752 but again, we need a lead mentor, so I act only as regular maintainer, helping with review

[SumantxD]

Project Proposal - [Mentorship Program 2023] (Drag&drop AsyncAPI block builder)

I would like to work on asyncapi/studio#265
@AceTheCreator @derberg @thulieblack Will it be available for the Mentorship programme ? if so i would love to work on it.

[Shurtu-gal]

@SumantxD I am already hoping to work on this.
asyncapi/studio#265 (comment)

[SumantxD]

@Shurtu-gal IMHO! , i think it's a big issue, it would be more suitable for the mentorship program. i would like to know mentainer's take on this .

[AceTheCreator]

Hey folks, this project won't be part of this year's mentorship program because of how complex it is, and I plan on working on it myself :)

[Shurtu-gal]

Sure would love to help wherever I can @AceTheCreator.

[Souvikns]

I would like to post a project from CLI, @AceTheCreator I need your opinion if we can make it into a project, we basically need help to prepare CLI for the v1 release.

Project Title: Prepare CLI for the 1.0 release

• reach 90% test coverage
• enable cross-platform installation- (only windows chocolatey)
• Documentation update - (update usage docs for all the commands with examples)
• Simple Integration tests to prove the binary works

[AceTheCreator]

Yea, of course

[SumantxD]

Project Idea: [Mentorship Program 2023] AsyncAPI Studio: Desktop/Native application for Async API studio

The AsyncAPI Studio is currently exclusively available as a web application, using it locally will require setting up the development environment, which can be a cumbersome process for certain users. In order to address this limitation and provide a more accessible solution, the objective of this project is to develop a cross-platform desktop application for the AsyncAPI Studio. By creating a downloadable version of the studio, users will be able to seamlessly run it on their devices without the need for an internet connection.

Project description:

The primary motivation behind this project is to enhance the user experience and convenience by eliminating the dependency on the web version or the complexities of building the application from source. By leveraging the power of the Qt framework we aim to create a native desktop application that encapsulates the full functionality of the AsyncAPI Studio. This will enable users to install the application on their devices with ease, ensuring they have a dedicated and offline-accessible environment for designing, visualizing, and managing their event-driven architectures.

Compared to web applications, desktop applications offer advantages such as:

• Offline functionality: Desktop applications can be run without an internet connection, providing users with access to the application and its features regardless of their online status.

• Direct system access: Desktop applications have greater access to system resources, hardware, and APIs, allowing for more advanced functionalities and integration with the user's device.

• Native performance: Desktop applications are typically optimized for specific operating systems and hardware, enabling them to deliver better performance compared to web applications.

• Custom UI and user experience: Desktop applications can have a customized user interface that matches the look and feel of the operating system, providing a more familiar and integrated user experience.

Approach :

To achieve high performance and offline functionality for the AsyncAPI Studio web application, we will leverage the Qt framework to create a native application that embeds the existing web application and provides additional features and optimizations.

1. Embed the web application in a Qt WebView:
   Qt's WebView component can be used to embed the existing AsyncAPI Studio web application within a Qt application. This allows the web application to run within a native environment while utilizing the Qt framework.

2. Offline functionality using local storage:
   Implement local storage capabilities within the Qt application to store necessary resources and data required by the AsyncAPI Studio web application. This enables the application to function offline by serving resources from the local storage when there is no internet connectivity.

3. Enhance offline functionality with background syncing:
   Implement background syncing capabilities within the Qt application to automatically synchronize changes made in the offline mode with the server once an internet connection is available. This ensures that users can seamlessly transition between offline and online modes while preserving their work.

4. Handle communication between the web application and Qt:
   Establish a communication bridge between the web application and the Qt application. This can be done using techniques like JavaScript-to-C++ bindings (if using C++) or Qt's WebChannel for bidirectional communication between the web application and the Qt application.

5. Customize the Qt application:
   Customize the appearance and behavior of the Qt application as desired, using Qt's styling and theming capabilities. This will allow you to provide a native look and feel to the AsyncAPI Studio application within the Qt environment.

6. Build and deploy:
   Qt provides tools and libraries to buld cross-platform application that can be distributed on various operating systems like (windows, macOS, Linux)

Extended Goals:

1. platform-specific integratios:
   We can leverage Qt's platform-specific integrations to provide native functionality and improve user experience. This could involve integration with platform-specific features like file system access, notifications, system tray icons, or other nativi capabilities that enhances application's functionalitya nd usability

2. Implement synchronization and conflict resolution:
   Introduce synchronization and conflict resolution mechanisms to handle collaborative editing and real-time updates in the Qt version of AsyncAPI Studio. This could involve integrating a real-time collaboration framework, implementing conflict detection and resolution strategies, and enabling version control functionality.

Conclusion

With the proposed desktop application, we aim to bridge the gap between the web version and the complexities of building from source, enabling users to enjoy the full capabilities of the AsyncAPI Studio in a convenient and downloadable package.

[AceTheCreator]

Hey Folks 👋🏾

While we received so many exciting projects for this year's mentorship program, unfortunately, we only received a handful of available mentors to drive these projects forward, which means we won't be having a vote to decide which project gets selected and which one we drop because the number of projects with mentors is equivalent to the amount of slot available for the program. So we are selecting projects with available mentors.

ICYM @asyncapi/tsc_members, we decided to increase the number of slots available for the program to 13 because project number 4 requires three mentees, so we need three more slots for the last three projects, and that is the reason behind 13 slots. Wouldn't that exceed the amount budgeted for the program, you might ask? We didn't maximize the amount budgeted for last year's program, as we have four projects not completed in the previous year, so we'll use from last year's budget.

Another clarification I'll like to make is the projects with Closed status. Projects one and three were supposed to be part of this year's GSOC but were dropped due to the number of slots available, and Project two was part of last year's mentorship program but was stalled due to one of the participants dropping out after the program kicked off. These projects already have mentees assigned to them, so interested candidates should refrain from sending proposals for these projects.

Could you approve the program with these projects? @asyncapi/tsc_members

No	Project Idea	Mentor/s	Category	Status & Reason	Mentee
1	Add help/{command} endpoint	BOLT04	Engineering	Closed. This project was part of GSoC proposed project but was dropped due to the number of available slots and mentor already have a preferred candidate with a strong proposal.	@princerajpoot20
2	Website UI Kit design/dev project	AceTheCreator	Design	Closed. This project was part of last year's mentorship program but was stalled due to one of the assigned mentees dropping out the program after kickoff while the other mentee is still active.	@Mayaleeeee
3.	MVP integration of extensions catalog with AsyncAPI tools	Lukasz Gornicki	Engineering	Closed. @sambhavgupta0705's consistent and valuable contributions to the AsyncAPI community were highly appreciated. Although we selected another candidate for GSoC, we are eager to have him join the AsyncAPI Mentorship program to continue his valuable work.	@sambhavgupta0705
4.	Documenting how different protocols work with AsyncAPI	Alejandra Quetzalli	Documentation	Open for Proposals
5.	Rewrite this template and NodeJS WS template	Lukasz Gornicki	Engineering	Open for Proposals
6.	Simulator Desktop Application	Nektarios Fifes	Engineering	Mentee selected. Confirming Participation
7.	Tutorial document or separate guides for glee	Souvik & Khuda Dad Nomani	Documentation	Open for Proposals
8.	Add support for translations	Maciej Urbańczyk	Engineering	Open for Proposals
9.	Prepare CLI for v1.0.0 release	Souvik	Engineering	Open for Proposals
10.	DocsUI: Messages Object output	Missy Turco & Fran Méndez	Design	Open for Proposals

[Neilblaze]

@AceTheCreator, @rukundob451 Thanks for the info! :)

[mcturco]

Hey @AceTheCreator and @mcturco,

I've been reviewing design ideas 10 and 11, and it appears that the 10th issue is actually a subset of the larger 11th issue. Considering this, how should I go about creating a proposal?

This is correct, there should be only one project which is 10. cc @AceTheCreator @fmvilas

[quetzalliwrites]

📣 Calling All Technical Writers! 🖊
Applications are now open for technical writer candidates via the following form: https://forms.gle/6jT5x3R9eaxHtLGR8.

Apply today! 🚀

[fmvilas]

I think we should keep 10 and 11 but remove the item "Messages Object output" from 11. What do you think, @mcturco?

[rukundob451]

Application deadline is today, kindly take note.

[thulieblack]

I would like to add,
If you are currently participating in an ongoing paid open-source program such as Google Summer of Code, Google Season of Docs, Outreachy, etc., with either AsyncAPI or another organization, please refrain from applying to the AsyncAPI Mentorship Program.

It is very important that you concentrate on the programs you are currently participating in and give others a chance to apply to the AsyncAPI Mentorship Program and also grow their skills in open source.

(thanks, @alequetzalli for the idea)

[rukundob451]

Thank you for this information @thulieblack, well mentioned here.

[thulieblack]

@Neilblaze thank you for bringing this to my attention. Could you please send me a dm in slack so that we can investigate this

[Neilblaze]

RE: @thulieblack, you advised against applying, but I'm seeing people successfully juggling both GSoC & AsyncAPI Mentorship simultaneously :)

[AceTheCreator]

@Neilblaze we are currently looking into this issue :)

[AceTheCreator]

@Neilblaze we only have one candidate in the program that applied despite his involvement in other paid mentorship programs. This candidate was accepted to participate in the program despite his involvement in other paid mentorship programs because he was the only candidate that applied for the project. Before he applied, he was transparent with the project mentor about his involvement in other paid mentorship programs and the mentor gave him the green light to apply. I hope this explanation is enough to convince why you why he was considered the selected candidate.

[Varshi4126]

@AceTheCreator How to submit my proposal.. Should I Create an issue?

[AceTheCreator]

Hey Folks,

For clarification on how to submit a proposal, you need to reach out to the project Mentor/s on Slack and send them your submission in the form of a document or ask them how best they'd prefer you submit your proposals

[nawed2611]

Any resources on how to frame the proposals? Thanks!

[AceTheCreator]

There's no format, write the way you see best, or better still, reach out to mentor/s and ask them what they'd prefer :)

[AceTheCreator]

Hey Folks!!! Here's to inform you y'all that the lists of the selected candidate will be published next week. Until then fingers crossed 🤞🏾

P.S. We have excluded one of the chosen projects(design) due to its relation and similarities to another selected project

[ayushnau]

@AceTheCreator where this list was published