Skip to content

Commit

Permalink
docs: add index.md for bindings folder (#3180)
Browse files Browse the repository at this point in the history
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
  • Loading branch information
akshatnema and derberg committed Sep 16, 2024
1 parent 12280d4 commit 30aeec6
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 1 deletion.
1 change: 1 addition & 0 deletions assets/docs/fragments/bindings-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Bindings in AsyncAPI provide a way to add protocol-specific information to the AsyncAPI documentation. They can be added to different document parts, such as servers, channels, or messages; they specify standard details specific to a particular protocol. The purpose of bindings is to enhance the API's understanding and usage by providing additional context and configuration options for different protocols.
4 changes: 3 additions & 1 deletion markdown/docs/concepts/asyncapi-document/adding-bindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ title: Adding bindings
weight: 260
---

Bindings in AsyncAPI provide a way to add protocol-specific information to the AsyncAPI documentation. They can be added to different document parts, such as servers, channels, or messages; they specify standard details specific to a particular protocol. The purpose of bindings is to enhance the API's understanding and usage by providing additional context and configuration options for different protocols.
import BindingsOverview from '../../../../assets/docs/fragments/bindings-overview.md'

<BindingsOverview/>

The following diagram highlights the sections where bindings can be implemented:

Expand Down
4 changes: 4 additions & 0 deletions markdown/docs/reference/bindings/_section.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Bindings
weight: 15
---
18 changes: 18 additions & 0 deletions markdown/docs/reference/bindings/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Overview
weight: 15
---

## Overview

import BindingsOverview from '../../../../assets/docs/fragments/bindings-overview.md'

<BindingsOverview/>

## Usage in an AsyncAPI document

To learn how to add bindings to your AsyncAPI document, read [Adding bindings](/docs/concepts/asyncapi-document/adding-bindings) concept document, or read the guide about using [Kafka bindings](/docs/tutorials/kafka/bindings-with-kafka).

## Contributing to bindings

Bindings are maintained by different community members that know and use given protocol and technology in production. If something can be improved, or some new binding is needed, open an issue in [bindings repository](https://github.com/asyncapi/bindings).

0 comments on commit 30aeec6

Please sign in to comment.