Skip to content

Commit

Permalink
Merge branch 'master' into ag_tsc
Browse files Browse the repository at this point in the history
  • Loading branch information
derberg authored Jan 3, 2024
2 parents f2839cd + 44b925d commit a6be9de
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 4 deletions.
18 changes: 18 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center" valign="top" width="14.28%"><a href="https://github.com/princerajpoot20"><img src="https://avatars.githubusercontent.com/u/44585452?v=4?s=100" width="100px;" alt="Prince Rajpoot"/><br /><sub><b>Prince Rajpoot</b></sub></a><br /><a href="https://github.com/asyncapi/community/commits?author=princerajpoot20" title="Code">πŸ’»</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://atamel.dev"><img src="https://avatars.githubusercontent.com/u/1177542?v=4?s=100" width="100px;" alt="Mete Atamel"/><br /><sub><b>Mete Atamel</b></sub></a><br /><a href="#talk-meteatamel" title="Talks">πŸ“’</a> <a href="https://github.com/asyncapi/community/pulls?q=is%3Apr+reviewed-by%3Ameteatamel" title="Reviewed Pull Requests">πŸ‘€</a> <a href="#maintenance-meteatamel" title="Maintenance">🚧</a> <a href="#ideas-meteatamel" title="Ideas, Planning, & Feedback">πŸ€”</a> <a href="#blog-meteatamel" title="Blogposts">πŸ“</a> <a href="#promotion-meteatamel" title="Promotion">πŸ“£</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/akkshitgupta"><img src="https://avatars.githubusercontent.com/u/96991785?v=4?s=100" width="100px;" alt="Akshit Gupta"/><br /><sub><b>Akshit Gupta</b></sub></a><br /><a href="https://github.com/asyncapi/community/commits?author=akkshitgupta" title="Documentation">πŸ“–</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nikhilkalburgi"><img src="https://avatars.githubusercontent.com/u/70331875?v=4?s=100" width="100px;" alt="nikhilkalburgi"/><br /><sub><b>nikhilkalburgi</b></sub></a><br /><a href="https://github.com/asyncapi/community/commits?author=nikhilkalburgi" title="Documentation">πŸ“–</a></td>
</tr>
</tbody>
</table>

Expand Down
2 changes: 1 addition & 1 deletion git-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
30 changes: 27 additions & 3 deletions new-tool-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

Expand Down Expand Up @@ -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": []
}
```
5 changes: 5 additions & 0 deletions tweets/recurring-discuss-ideas/2024-01-01.tweet
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2023-12-23.tweet
Original file line number Diff line number Diff line change
@@ -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. πŸ’ͺ🏿πŸ’ͺ🏽🦾
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2023-12-30.tweet
Original file line number Diff line number Diff line change
@@ -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. πŸ’ͺ🏿πŸ’ͺ🏽🦾

0 comments on commit a6be9de

Please sign in to comment.