Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add index.md for bindings folder #3180

Merged
merged 6 commits into from
Sep 16, 2024
Merged

docs: add index.md for bindings folder #3180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bcead48
added index.md for bindings folder
akshatnema Aug 31, 2024
08a272e
Added section.md and index.md
akshatnema Sep 9, 2024
045ca80
Merge branch 'master' into feature/add-bindings-index-page
akshatnema Sep 9, 2024
a92c3e5
fixed adding-bindings.md
akshatnema Sep 9, 2024
6aac78c
Update markdown/docs/reference/bindings/index.md
akshatnema Sep 12, 2024
c59802d
Merge branch 'master' into feature/add-bindings-index-page
derberg Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions assets/docs/fragments/bindings-overview.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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/>
akshatnema marked this conversation as resolved.
Show resolved Hide resolved

## 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).
Loading