AsyncAPI Initiative
AsyncAPI Initiative: GSoD 2023 Application #601
Replies: 20 comments 5 replies
-
|
AsyncAPI Initiative GSoD 2023 application is submitted.
|
Beta Was this translation helpful? Give feedback.
-
|
that's amazing |
Beta Was this translation helpful? Give feedback.
-
|
Hello, I'm a web developer and a Technical Writer. I would love to contribute to this amazing project. |
Beta Was this translation helpful? Give feedback.
-
|
Hi everyone! The most important fact that makes me stand out is that my writing style try to convey the information in such a manner which is not too techy as well as not to overwhelming for beginners at the same time. Therefore i would be really interested to contribute as a technical writer for projects at asyncapi as part of Google Season Of Docs Program 2023. Please find my resume, writing samples and documentation everything here in the bio link |
Beta Was this translation helpful? Give feedback.
-
|
Interested in working with this project. |
Beta Was this translation helpful? Give feedback.
-
|
Hi @alequetzalli How should I reach out to you expressing my interest for GSoD'23 program? I couldn't find your email so would be great if you could let me know and I couls share my interest for participating there. |
Beta Was this translation helpful? Give feedback.
-
|
I am writing to express my interest in participating in the Google Summer of Code program as a technical writer for your organization. As a second-year Information Technology student at IIIT Allahabad, I have gained one year of experience writing technical documentation for my college's technical wing. |
Beta Was this translation helpful? Give feedback.
-
|
Holla @alequetzalli |
Beta Was this translation helpful? Give feedback.
-
|
Hello, E-mail - [email protected] |
Beta Was this translation helpful? Give feedback.
-
|
That's amazing. Want to contribute |
Beta Was this translation helpful? Give feedback.
-
|
We hope you are excited about the Google Season of Docs program with AsyncAPI. We want to remind everyone that communication during the program will primarily take place on Slack, and we kindly ask that you join the AsyncAPI Slack workspace and our dedicated docs channels detailed in this application to stay up-to-date with important updates and announcements. We have noticed that some individuals are not following these instructions and are instead spamming the GitHub discussion with introductions. Please be advised that this is not the appropriate channel for this type of communication, and we kindly ask that you respect the guidelines we have set forth. We want to ensure that everyone has a positive and productive experience during the program, and effective communication is a key component of that. Thank you for your cooperation and understanding. |
Beta Was this translation helpful? Give feedback.
-
|
Wow. I am interested in putting my skills to good ysefor this year's GSoD. I can't wait. |
Beta Was this translation helpful? Give feedback.
-
|
I am interested in contributing to this project. |
Beta Was this translation helpful? Give feedback.
-
|
Hello may I know where to find the the application form? |
Beta Was this translation helpful? Give feedback.
-
|
Hello 👋 Links:- |
Beta Was this translation helpful? Give feedback.
-
|
I am writing to apply for the Technical Writer position for the 2023 program. As a B.Tech student with a minor in Computer Science and experience in research and technical writing, I believe I am well-suited for this role. My education in Instrumentation and Control, minors in Computer Science, and relevant coursework in Data Science, Artificial Intelligence, and Automation have provided me with a solid foundation in technical concepts. Moreover, my internships at the Max Planck Institute for Software Systems and the Indian Institute of Management have given me hands-on experience in implementing ML prototypes and data analytics. I have authored multiple research publications, including "Cryptocurrency Price Prediction using Machine Learning" and "Autonomous Mobile Robot for Inventory Management in Retail Industry" in Springer conference proceedings. I am also proficient in various programming languages such as Python, C/C++, and R, and possess experience in using tools such as JIRA, Git, and Github. I would be thrilled to work with Aysnc API's world-class team of technical writers to produce high-quality documentation that improves the user experience. |
Beta Was this translation helpful? Give feedback.
-
|
Hi , |
Beta Was this translation helpful? Give feedback.
-
|
I am interested to contribute to this project |
Beta Was this translation helpful? Give feedback.
-
|
Hey , My education in Instrumentation and Control, minors in Computer Science, and relevant coursework in Data Science, Artificial Intelligence, and Automation have provided me with a solid foundation in technical concepts. Moreover, my internships at the CodeClause had given me a good experience of technical writing. |
Beta Was this translation helpful? Give feedback.
-
|
https://drive.google.com/file/d/1BtKAqod-i-TIhDzXRL2Ml3wXs40tyEyJ/view?usp=drivesdk |
Beta Was this translation helpful? Give feedback.
-
|
my resume link for more detail of my work and knowledge you can visit this. |
Beta Was this translation helpful? Give feedback.
-
|
@SimpleKumari Afaik, the deadline for applying (if you're referring to GSoD'23) has already passed on April 15th, 2023. However, you are more than welcome to contribute anytime! :) |
Beta Was this translation helpful? Give feedback.
-
|
Sir ,
Is the contribution still counted in the GSoD 2023 ?
Is yes let me know please
…On Fri, 12 May 2023, 14:29 Pratyay Banerjee, ***@***.***> wrote:
@SimpleKumari <https://github.com/SimpleKumari> Afaik, the deadline for
applying (if you're referring to GSoD'23) has already passed on April 15th,
2023. However, you are more than welcome to contribute anytime! :)
—
Reply to this email directly, view it on GitHub
<#601 (reply in thread)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AYYC4X3HZ62WX7ZZBJ4ECZTXFX3XLANCNFSM6AAAAAAU5T74EQ>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Beta Was this translation helpful? Give feedback.
-
|
@SimpleKumari, technical writers selected for GSoD'23 have a specific set of issues assigned to them during the contribution period. Any other contributions, such as documentation, would be considered separate and independent contributions. |
Beta Was this translation helpful? Give feedback.
-
|
Good day @alequetzalli I tried joining the Slack channel via https://asyncapi.slack.com/join/shared_invite/zt-153ifujzl-fD4W~~LxiRroF8E5bx80qA#/shared-invite/error |
Beta Was this translation helpful? Give feedback.
-
🦄 Hola
¡Hola, AsyncAPI community! 😄
For today's latest announcement around AsyncAPI Docs 📑, I wanted to share with all technical writers about our organization’s plan for participation in
Google Season of Docs 2023 (GSoD). Any and all technical writers are welcome to come and interview with us for GSoD 2023 season, regardless of tech background or years of experience! At AsynAPI, we love mentoring folks who want to get involved in OSS, tech, and Docs. ❤️ If AsyncAPI is accepted into GSoD 2023, we will conduct interviews and review portfolios. Stay tuned!As some may remember, last year, AsyncAPI participated successfully in GSoD 2022, and I wrote a case study summarizing the work involved and our results.
In anticipation of our application for this year, I have created a new AsyncAPI Slack channel named
#temp-gsod-2023that anyone can join! First, join our Slack workspace ☎️ and please respect our slack etiquette.🙂 Then join the#temp-gsod-2023channel, our temporary channel, to coordinate GSoD 2023 setup. I'll publish regular updates on where we are in the application process, so stay tuned as the process continues. 🙂Join the
#temp-gsod-2023slack channel for:Below is the project proposal we've submitted to
GSoD 2023, and then we close with a reminder of how to get started as an AsyncAPI Docs contributor:🙌🏾 Bridge AsyncAPI Document Knowledge Gaps & Build Interactive Learning Paths
❤️ About AsyncAPI
AsyncAPI (currently version 2.6.0, first released in 2016) is an Apache License 2.0 library under the Linux Foundation that seeks to improve the current state of Event-Driven Architectures (EDA). The AsyncAPI Initiative is a specification and growing set of open-source tools to help developers define asynchronous APIs and build and maintain EDAs. Developers familiar with OpenAPI (aka Swagger) for RESTful APIs will see strong similarities when using AsyncAPI. One common use case is generating documentation (HTML or Markdown) of an asynchronous API. The specification is both platform and language-agnostic. Current tooling includes support for common message brokers such as Apache Kafka and RabbitMQ and languages including Python, Java, and Nodejs. Our long-term goal is to make working with EDAs as easy as working with REST APIs. That goes from documentation to code generation, discovery to event management, and beyond. Our 150+ Open-Source (OSS) contributors are EDA enthusiasts from all around the world.
📑 About our Docs project
🔎 Our current Docs problems
First solution: cover AsyncAPI document sections in detail
First, the AsyncAPI documentation needs more in-depth explanations of the different sections of an AsyncAPI document to avoid difficulties in implementing EDAs.
Here are the individual sections of an AsyncAPI document we need to cover:
components.serverVariables.securityprop at the operation level.oneOf) under operation. Talk aboutcontentTypeand add a note aboutdefaultSchema. Also, show how to reuse components.$refconcept, introduce and explain that$refcan point to the same document, other documents in a local system, and external URLs.Second solution: Interactive Learning Paths
Second, our only educational content is static AsyncAPI documentation; the community needs more engaging and interactive ways to learn AsyncAPI concepts and architecture. To make learning AsyncAPI more accessible and enjoyable, we propose creating interactive learning paths that incorporate best practices. Our solution is to create interactive learning paths with engaging videos, gamification elements, immersive storylines with eLearning characters, badges, quizzes, points systems, etc.
By integrating these elements, we aim to make the learning experience more enjoyable and rewarding for the entire community. We can have videos that showcase AsyncAPI in action and visual animations of AsyncAPI spec terms and architecture. We'd love to create a learning experience that is useful, fun, and interactive! The first learning paths would also be able to re-purpose content from the current AsyncAPI Docs content buckets of tutorials and concepts, which were created thanks to GSoD 2022.
In addition, we can create said interactive learning paths on the current Killercoda AsyncAPI profile ...
...or even host them with Linux Foundation interactive content.
🎯 Our Docs project’s scope
As a result, AsyncAPI is proposing two projects for the Google Season of Docs 2023:
📏 Measuring our Docs project’s success
We will partially measure success in the Docs project by capturing specific feedback about these changes via our Docs feedback card, how many new OSS Docs contributors we gain from this effort, and by measuring engagement via our Docs analytics.
We will also track the number of views, likes, and shares of any new videos to measure user engagement. We'll even monitor user feedback to continue improving our videos further.
⌛ Timeline
The project will take approximately 4-6 months to complete, depending on the different levels of knowledge from diverse technical writers (TW) that might get involved. (At AsyncAPI, we want to work with any TW, regardless of their years of experience. We have a passion for mentorship, and we do not wish to have a bar that would prevent any TW from contributing to our OSS Initiative. We look forward to mentoring TW(s) who are completely new to tech and making them feel welcome!)
The timeline would look as follows:
first-time-ticketsto get each new TW contributor started.GSoD 2023. Each TW starts creating documentation for the issues assigned/selected.💸 Project budget
We'll set aside 2-3 mentors for our two proposed projects: documenting the AsyncAPI document sections in detail and creating educational videos. Should we be selected, AsyncAPI would like to request from Google a US $5000 budget for each project. For both projects, the request then totals a $10,000 budget. That said, we would also like to request an additional $350 dollars in our budget to provide cool swag for participants.
👉🏽 Get started contributing to AsyncAPI Docs Today
Last but not least, don't forget that code isn't the only way to contribute to OSS; Dev Docs are a huge help that benefits the entire OSS ecosystem. At AsyncAPI, we value Doc contributions as much as every other type of contribution. ❤️
To get started as a Docs contributor:
🏷 Tag me in your AsyncAPI Doc PRs
Do you have a documentation contributor question, and you're wondering how to tag me into a GitHub discussion or PR? Never fear!
Tag me in your AsyncAPI Doc PRs or GitHub Discussions via my GitHub handle,
alequetzalli🐙.-A.Q. 👩🏻💻 and Canela 🐕🦺
Beta Was this translation helpful? Give feedback.
All reactions