Merge branch 'asyncapi:master' into onboarding-maintainers-guide

Author: Aahil13

.github/workflows/slack-integration.yml

@@ -14,6 +14,11 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Install terraform
+        uses: hashicorp/setup-terraform@v3
+        with:
+          terraform_version: "^1.3.7"
+          terraform_wrapper: false   
       - name: Deploy changes to Slack
         run: |
           cd .github/workflows/slack

.github/workflows/slack/channels/channels.tf

@@ -57,7 +57,7 @@ locals {
       purpose = lookup(lookup(lookup(wg_data, "slack", {}), "channel", {}), "description", lookup(wg_data, "description", ""))
       topic = lookup(lookup(lookup(wg_data, "slack", {}), "channel", {}), "topic", "")
 
-      permanent_members = concat([for member in wg_data.chairpersons : member.slack], [for member in wg_data.members : member.slack])
+      permanent_members = concat([for member in wg_data.chairpersons : lookup(member, "slack", null)], [for member in wg_data.members : lookup(member, "slack", null)])
       is_private = false
 
       action_on_destroy = "archive"

.github/workflows/slack/groups/groups.tf

@@ -59,7 +59,7 @@ locals {
 
       # Handle will be the name of the group in lowercase and with spaces replaced by hyphens succeded by "wg-"
       handle = lookup(lookup(lookup(wg_data, "slack", {}), "group", {}), "handle", "${replace(lower(wg_data.name), " ", "-")}-wg")
-      users = concat([for member in wg_data.chairpersons : member.slack], [for member in wg_data.members : member.slack])
+      users = concat([for member in wg_data.chairpersons : lookup(member, "slack", null)], [for member in wg_data.members : lookup(member, "slack", null)])
     }
   }
 }

.github/workflows/slack/users/users.tf

@@ -17,14 +17,14 @@ locals {
   repos = setunion(flatten([for maintainer in local.maintainers_data : maintainer.repos]))
   repo_maintainers = {
     for repo in local.repos : repo => 
-      [for maintainer in local.maintainers_data : maintainer.slack if contains(maintainer.repos, repo)]
+      [for maintainer in local.maintainers_data : lookup(maintainer, "slack", null) if contains(maintainer.repos, repo)]
   }
 }
 
 output "data_sources" {
   value = {
-    maintainers_user_ids = [for maintainer in local.maintainers_data : maintainer.slack]
-    tsc_members_user_ids = [for tsc_member in local.tsc_members_data : tsc_member.slack]
+    maintainers_user_ids = [for maintainer in local.maintainers_data : lookup(maintainer, "slack", null)]
+    tsc_members_user_ids = [for tsc_member in local.tsc_members_data : lookup(tsc_member, "slack", null)]
     repo_maintainers = local.repo_maintainers
   }
 }

.github/workflows/update-docs-in-website.yml

@@ -0,0 +1,86 @@
+name: Update latest Community documentation in the website
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - 'master'
+    paths:
+      - 'docs/**/*.md'
+
+jobs:
+  Make-PR:
+    name: Make PR on website repository with updated latest Community documentation
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+    steps:
+      - name: Checkout Current repository
+        uses: actions/checkout@v4
+        with:
+          path: community
+      - name: Checkout Another repository
+        uses: actions/checkout@v4
+        with:
+          repository: asyncapi/website
+          path: website
+          token: ${{ env.GITHUB_TOKEN }}
+      - name: Config git
+        run: |
+          git config --global user.name asyncapi-bot
+          git config --global user.email [email protected]
+      - name: Create branch
+        working-directory: ./website
+        run: |
+          git checkout -b update-community-docs-${{ github.sha }}
+      - name: Update edit-page-config.json
+        uses: actions/github-script@v4
+        with:
+          script: |
+                const fs = require('fs').promises;
+                const configPath = './website/config/edit-page-config.json';
+                const configData = require(configPath);
+                const docsDir = 'community/docs';
+                
+                async function readDirectories(dirPath) {
+                    const entries = await fs.readdir(dirPath, { withFileTypes: true });
+                    const subdirectories = entries.filter(entry => entry.isDirectory()).map(entry => entry.name);
+                    return subdirectories;
+                }
+                
+                async function updateConfigData() {
+                    const subfolders = await readDirectories(docsDir);
+                    
+                    for (const subfolder of subfolders) {
+                        const checkSlug = `community/${subfolder}`;
+                        const slug = {
+                            "value": checkSlug,
+                            "href": `https://github.com/asyncapi/community/tree/master/docs/${subfolder}`
+                        };
+                
+                        const entryExists = configData.some(entry => entry.value === checkSlug);
+                        if (!entryExists) {
+                            configData.push(slug);
+                        }
+                    }
+                
+                    await fs.writeFile(configPath, JSON.stringify(configData, null, 2));
+                }
+                updateConfigData();
+
+      - name: Copy community folder from Current Repo to Another
+        working-directory: ./website
+        run: |
+          find "./markdown/docs/community" -mindepth 1 -maxdepth 1 -type d -exec rm -rf {} +
+          rm ../community/docs/README.md
+          mv ../community/docs/* ./markdown/docs/community/
+      - name: Commit and push
+        working-directory: ./website
+        run: |
+          git add .
+          git commit -m "docs(community): update latest community docs"
+          git push https://${{ env.GITHUB_TOKEN }}@github.com/asyncapi/website
+      - name: Create PR
+        working-directory: ./website
+        run: |
+          gh pr create --title "docs(community): update latest community documentation" --body "Updated community documentation is available and this PR introduces update to community folder on the website" --head "update-community-docs-${{ github.sha }}"

AMBASSADORS_MEMBERS.json

@@ -416,37 +416,6 @@
       }
     ]
   },
-  {
-    "name": "Raphael De Lio",
-    "github": "raphaeldelio",
-    "twitter": "raphaeldelio",
-    "linkedin": "raphaeldelio",
-    "country": "🇧🇷",
-    "bio": "Raphael De Lio is a passionate software engineer who loves to think about solutions and ways to improve anything he touches. He was born in Brazil, lived in Portugal for five years, and now works as a consultant in the Netherlands. In his quest for knowledge, Raphael has always valued learning and sharing insights with others. This pursuit not only led him to Xebia, a place where he found a community of engineers who share his enthusiasm for technology and continuous improvement but also to becoming the co-organizer of the Amsterdam Kotlin MeetUp, where he has been able to enable other speakers to share their knowledge as well.",
-    "company": "Xebia",
-    "title": "Software Consultant at Xebia",
-    "img": "https://avatars.githubusercontent.com/u/25641721?v=4",
-    "contributions": [
-      {
-        "type": "article",
-        "title": "AsyncAPI — A standard specification for documenting Event-Driven Applications",
-        "date": {
-          "year": 2024,
-          "month": "February"
-        },
-        "link": "https://medium.com/@raphaeldelio/asyncapi-a-standard-for-documenting-event-driven-applications-8ff657119036"
-      },
-      {
-        "type": "presentation",
-        "title": "AsyncAPI & Springwolf - Automated documentation (and more)",
-        "date": {
-          "year": 2024,
-          "month": "May"
-        },
-        "link": "https://www.youtube.com/watch?v=DylvTW_ia4Y"
-      }
-    ]
-  },
   {
     "name": "Hari Krishnan",
     "github": "harikrishnan83",

Emeritus.yaml

@@ -22,3 +22,4 @@ emeritus_tsc:
 emeritus_ambassadors:
   - jessemenning
   - meteatamel
+  - raphaeldelio

docs/onboarding-guide/docs-onboarding-checklist.md

@@ -12,8 +12,8 @@ Complete in order the following onboarding tasks:
 - [ ] Read the [AsyncAPI Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md). 
 - [ ] Join [the AsyncAPI Slack workspace](https://asyncapi.com/slack-invite).
 - [ ] Add the AsyncAPI calendar found in [the AsyncAPI events page](https://www.asyncapi.com/community/events).
-- [ ] Read the list of [technical writer contributor responsibilities](/docs/onboarding-guide/technical-writer-contributor-responsibilities.md).
-- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](/docs/onboarding-guide/prerequisite-knowledge.md).
+- [ ] Read the list of [technical writer contributor responsibilities](/docs/onboarding-guide/technical-writer-contributor-responsibilities).
+- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](/docs/onboarding-guide/prerequisite-knowledge).
 - [ ] Familiarize yourself with the _work-in-progress_ [AsyncAPI Style Guide](https://github.com/asyncapi/community/pulls?q=is%3Apr+is%3Aopen+style+guide).
 - [ ] Read all docs under the following content buckets: `Concepts`, `Tutorials`, `Reference`. (Take the time to go through each tutorial.)
 - [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md).

docs/donating-projects.md renamed to donating-projects.md

@@ -0,0 +1,19 @@
+# Projects ideas
+
+### Ideas list
+
+Number | Idea | Area | Lead Mentor | Scope
+:---:|---|:---:|:---:|---
+1 | [Enhancing Developer Experience in CLI](https://github.com/asyncapi/cli/issues/15) | AsyncAPI CLI | [Aayush Saini](https://github.com/AayushSaini101) | Validate an AsyncAPI file against custom spectral rules & sync my local AsyncAPI file with a remote system (e.g registry). Publish my AsyncAPI file in a schema registry and render AsyncAPI documentation. Fix test cases, we cannot execute test cases directly in the CLI and remaining DX issues in CLI Board.
+2 | [AI-Powered AsyncAPI Generator](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10505262) | [AsyncAPI Generator](https://github.com/asyncapi/generator) | [Azeez Elegbede](https://github.com/AceTheCreator) | Create an AI-based extension for the AsyncAPI Generator that automatically generates initial AsyncAPI specifications from natural language descriptions or existing API documentation. Leveraging NLP models, this tool can take user-provided requirements and convert them into accurate AsyncAPI specs.
+3 | [Becoming a Maintainer of AsyncAPI Generator](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10520123) | [AsyncAPI Generator](https://github.com/asyncapi/generator) | [Lukasz Gornicki](https://github.com/derberg) | This initiative aims to guide you on a journey from being a contributor to becoming a maintainer of the project. You'll gain insight into the responsibilities of a maintainer, involving tasks beyond mere coding. Goal is same as [GSoC.](https://github.com/asyncapi/generator/issues/1145)
+4 | [Performance + Accessibility Improvement of website](https://github.com/asyncapi/website/issues/3186) | [AsyncAPI website](https://github.com/asyncapi/website) | [Sambhav Gupta](https://github.com/sambhavgupta0705) |With the addition of multiple components, pages and MD files, it's now important for us to make the website efficient for all web + mobile users. Currently, the performance of the website has critically low numbers in both web and mobile view, which can impact the efficiency and user views in the website. On the other hand, it's also important that we add the necessary accessibility labels to the website. 
+5 | [Migration of build + workflow scripts to typescript](https://github.com/asyncapi/website/issues/3187) | [AsyncAPI website](https://github.com/asyncapi/website) | [Ansh Goyal](https://github.com/anshgoyalevil) | With the current package.json built for ES modules and packages, as we migrated the website to Next js 14 + Typescript, it has now started affecting the scripts folder like working of meetings workflow, automation of blog creation using npm script, etc. Since, to have uniformity across the website, we decided to migrate the existing Node js scripts to common js modules (in Typescript), enhancing the code maintenance, scalability, and readability for contributors.
+6 | [User Research + Usability Testing on the AsyncAPI Website](https://github.com/asyncapi/website/issues/529) | User Research | [Aishat Muibudeen](https://github.com/Mayaleeeee) | It would be beneficial if we were to start performing usability tests across our tools periodically to help us gather data that could lead to more grounded ideas for design improvements. Create a new page on the website that can explain the process of being a participant in a user research study and steps to get involved. And because we are open source, this page could also attract an audience of other product designers looking to make open source contributions or to maybe gain experience conducting a user research study. 
+7 | [Holopin Design Project](https://github.com/asyncapi/community/issues/1306) | Design | [Aishat Muibudeen](https://github.com/Mayaleeeee)|This project aims to create visually appealing and user-friendly digital badges for our community, ensuring alignment with AsyncAPI's branding and easy recognizability. The goal is to recognize member contributions and creating a vibrant, active community with Holopin’s digital badges.
+8 | [Integrating EDAVisualiser Application Focus View into VS Code AsyncAPI Plugin](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10540858) | [AsyncAPI Preview](https://github.com/asyncapi/vs-asyncapi-preview) | [Ivan](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](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.
+9 | [Onboarding Contributor Guides](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10610947) | Docs | [V. Thulisile Sibanda](https://github.com/thulieblack), [Wisdom](https://github.com/wise4rmgod), [Anthony](https://github.com/bandantonio) |The AsyncAPI documentation must include a persona-driven journey for different roles, such as documentation contributors, code contributors, ambassadors, maintainers, etc. The onboarding experience for new contributors isn't as efficient yet, and to solve this problem, we need to develop a series of onboarding guides to automate the onboarding process for new contributors.
+10 | [Implementation and integration of new layout for studio](https://github.com/asyncapi/studio/issues/634) | [AsyncAPI Studio](https://github.com/asyncapi/studio) | [Ashish Padhy](https://github.com/Shurtu-gal) & [Fran Méndez](https://github.com/fmvilas) |Studio goes beyond a simple playground to try out the spec and becomes a fully-featured suite to help developers work with event-driven architectures (EDA) and APIs. It will become a tool you can use to easily design your services and share them with your colleagues.
+11 | [Path to Maintainership for the AsyncAPI React Project](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10811342) | Coding | [Azeez Elegbede](https://github.com/AceTheCreator) |The [AsyncAPI React component](https://github.com/asyncapi/asyncapi-react) is a handy tool for rendering documentation from your asynchronous APIs, all based on the AsyncAPI specification format. Plus, it helps validate that spec too.
+12 | [Expand Community Docs](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10818908) | Docs | [V. Thulisile Sibanda](https://github.com/thulieblack), [Wisdom](https://github.com/wise4rmgod), [Anthony](https://github.com/bandantonio) |Automating the AsyncAPI onboarding experience also involves documenting important workflows and processes for community members involved.
+13 | [Technical Blog Posts on Integrating AsyncAPI with Kafka](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10885096) | Docs | [Leonardo](https://github.com/leonardotorresaltez) |  Integrating AsyncAPI with Kafka offers a structured approach to managing and documenting Kafka topics, streamlining communication between teams, and enhancing development efficiency. This proposal outlines a series of technical blog posts focused on AsyncAPI’s capabilities, Kafka’s integration potential, and best practices for using these technologies together.

docs/how-changes-in-the-spec-are-introduced.md renamed to how-changes-in-the-spec-are-introduced.md

@@ -0,0 +1,5 @@
+Do you have some nice ideas for #AsyncAPI-related tools? Do you want to validate and share with the AsyncAPI community?
+
+Drop it 👇 and let us have an open discussion 🚀
+
+https://github.com/asyncapi/community/discussions/categories/ideas

mentorship/asyncapi-mentorship/2024/project-ideas.md

@@ -0,0 +1,7 @@
+✨ Did you know #AsyncAPI is on Slack? ✨ 
+
+Join our Slack workspace to chat with anyone from our Open-Source community! 
+
+🔗 asyncapi.com/slack-invite 
+
+Ask for help and help others too. 💪🏿💪🏽🦾