diff --git a/.all-contributorsrc b/.all-contributorsrc index d8e7bd969..9423d1e4b 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -430,6 +430,24 @@ "blog", "promotion" ] + }, + { + "login": "akkshitgupta", + "name": "Akshit Gupta", + "avatar_url": "https://avatars.githubusercontent.com/u/96991785?v=4", + "profile": "https://github.com/akkshitgupta", + "contributions": [ + "doc" + ] + }, + { + "login": "nikhilkalburgi", + "name": "nikhilkalburgi", + "avatar_url": "https://avatars.githubusercontent.com/u/70331875?v=4", + "profile": "https://github.com/nikhilkalburgi", + "contributions": [ + "doc" + ] } ], "commitConvention": "angular", diff --git a/README.md b/README.md index 87a728b75..c20b9ecb2 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d Prince Rajpoot
Prince Rajpoot
πŸ’» Mete Atamel
Mete Atamel
πŸ“’ πŸ‘€ 🚧 πŸ€” πŸ“ πŸ“£ + + Akshit Gupta
Akshit Gupta
πŸ“– + nikhilkalburgi
nikhilkalburgi
πŸ“– + diff --git a/git-workflow.md b/git-workflow.md index ad4856788..86da5f0e0 100644 --- a/git-workflow.md +++ b/git-workflow.md @@ -44,7 +44,7 @@ The result is as follows: ``` git remote add upstream https://github.com/asyncapi/asyncapi.git ``` -3. Run the `git fetch upstream master` command to fetch all branches. +3. Run the `git fetch upstream master` command to fetch all the changes from upstream/master branch. 4. Set up the local `master` branch to track the remote `master` branch from the upstream repository: ``` git branch -u upstream/master master diff --git a/new-tool-documentation.md b/new-tool-documentation.md index cee7bbfa5..b854249dc 100644 --- a/new-tool-documentation.md +++ b/new-tool-documentation.md @@ -3,7 +3,8 @@ title: Add new AsyncAPI tool to website description: Learn how to add your tool to the AsyncAPI website using the .asyncapi-tool file. --- -## Introduction +## Introduction + Learn how to add your tool to the AsyncAPI website using the `.asyncapi-tool` file. Make sure to structure your `.asyncapi-tool` file correctly to render your tool on the AsyncAPI website with customized tags and information for users to filter tools according to different categories. > The entire AsyncAPI Tools list is under the [AsyncAPI Tools Dashboard](https://www.asyncapi.com/tools) page. @@ -12,11 +13,11 @@ Learn how to add your tool to the AsyncAPI website using the `.asyncapi-tool` fi The [`.asyncapi-tool` file](https://github.com/asyncapi/website/blob/master/scripts/tools/tools-schema.json) requires a specific schema to describe the type and details of your AsyncAPI tool; this file automatically adds your tool to our website's [Tools Dashboard](https://www.asyncapi.com/tools) within a week. Every Monday, we run our workflow to add new tools or update existing tools in our website and thus, notifies us regarding the wrong format of the file used somewhere in Github using Slack notifications. You can even ask the maintainers to manually trigger workflow by [Creating a Github issue](https://github.com/asyncapi/website/issues/new/choose) or contact us via [AsyncAPI Slack](https://asyncapi.com/slack-invite). -You must create and maintain your `.asyncapi-tool` file in your tool's repository, as it doesn't require AsyncAPI approval. There is no restriction on the directory in which the file has to be created. In case, you need to create 2 or more `.asyncapi-tool` files in same repository, you can do the same, just make sure you provide correct `repoUrl` for each of them. Same case applies for monorepo as well. +You must create and maintain your `.asyncapi-tool` file in your tool's repository, as it doesn't require AsyncAPI approval. There is no restriction on the directory in which the file has to be created. In case, you need to create 2 or more `.asyncapi-tool` files in same repository, you can do the same, just make sure you provide correct `repoUrl` for each of them. Same case applies for monorepo as well. ## Tool file structure -Let's look at a sample `.asyncapi-tool` file in `JSON` and `YAML` structures. You'll use these file structures to insert your tool into the website's [Tools Dashboard](https://www.asyncapi.com/tools). +Let's look at a sample `.asyncapi-tool` file in `JSON` and `YAML` structures. You'll use these file structures to insert your tool into the website's [Tools Dashboard](https://www.asyncapi.com/tools). ### JSON format file structure @@ -118,3 +119,26 @@ Here's what a sample JSON object for an AsyncAPI tool should look like after it ``` > If your tool's information isn't showing up correctly in this file, please [create a new AsyncAPI GitHub issue](https://github.com/asyncapi/website/issues/new/choose) or contact us via [AsyncAPI Slack](https://asyncapi.com/slack-invite). + +## Adding New Category + +The category list is available in the [`categorylist.js` file](https://github.com/asyncapi/website/blob/master/scripts/tools/categorylist.js) from where you can opt the best category for your tools. Moreoever, if you don't find any, you can send us a request to add a new category that goes best with your requirements. + +You can also create a [Pull Request](https://github.com/asyncapi/website/pulls) by adding a new category object in the `categorylist.js` file providing all the details/information about the new category, as follows: + +```js +{ + name: "Sample category name", + tag: "sample-tag", + description: "Description providing some information about the category and other nitty-gritty things about the category." +} +``` + +Also, add the new category details in the [`tools-manual.json` file](https://github.com/asyncapi/website/blob/master/config/tools-manual.json) with proper json schema, as well. + +```JSON + "Sample category name": { + "description": "Description that provides some information about the category and other nitty-gritty things about the category.", + "toolsList": [] + } +``` diff --git a/tweets/recurring-discuss-ideas/2024-01-01.tweet b/tweets/recurring-discuss-ideas/2024-01-01.tweet new file mode 100644 index 000000000..92b19fefe --- /dev/null +++ b/tweets/recurring-discuss-ideas/2024-01-01.tweet @@ -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 \ No newline at end of file diff --git a/tweets/recurring-slack-link/2023-12-23.tweet b/tweets/recurring-slack-link/2023-12-23.tweet new file mode 100644 index 000000000..0bd3e8865 --- /dev/null +++ b/tweets/recurring-slack-link/2023-12-23.tweet @@ -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. πŸ’ͺ🏿πŸ’ͺ🏽🦾 \ No newline at end of file diff --git a/tweets/recurring-slack-link/2023-12-30.tweet b/tweets/recurring-slack-link/2023-12-30.tweet new file mode 100644 index 000000000..0bd3e8865 --- /dev/null +++ b/tweets/recurring-slack-link/2023-12-30.tweet @@ -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. πŸ’ͺ🏿πŸ’ͺ🏽🦾 \ No newline at end of file