From 30aeec615a76a5dc1139dacac9603b78431219d7 Mon Sep 17 00:00:00 2001 From: Akshat Nema <76521428+akshatnema@users.noreply.github.com> Date: Mon, 16 Sep 2024 13:49:20 +0530 Subject: [PATCH] docs: add index.md for bindings folder (#3180) Co-authored-by: Lukasz Gornicki --- assets/docs/fragments/bindings-overview.md | 1 + .../asyncapi-document/adding-bindings.md | 4 +++- markdown/docs/reference/bindings/_section.md | 4 ++++ markdown/docs/reference/bindings/index.md | 18 ++++++++++++++++++ 4 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 assets/docs/fragments/bindings-overview.md create mode 100644 markdown/docs/reference/bindings/_section.md create mode 100644 markdown/docs/reference/bindings/index.md diff --git a/assets/docs/fragments/bindings-overview.md b/assets/docs/fragments/bindings-overview.md new file mode 100644 index 000000000000..5f92b0ca3800 --- /dev/null +++ b/assets/docs/fragments/bindings-overview.md @@ -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. diff --git a/markdown/docs/concepts/asyncapi-document/adding-bindings.md b/markdown/docs/concepts/asyncapi-document/adding-bindings.md index ef5d75de346a..7380fc5c30a3 100644 --- a/markdown/docs/concepts/asyncapi-document/adding-bindings.md +++ b/markdown/docs/concepts/asyncapi-document/adding-bindings.md @@ -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' + + The following diagram highlights the sections where bindings can be implemented: diff --git a/markdown/docs/reference/bindings/_section.md b/markdown/docs/reference/bindings/_section.md new file mode 100644 index 000000000000..1b810dd42e3d --- /dev/null +++ b/markdown/docs/reference/bindings/_section.md @@ -0,0 +1,4 @@ +--- +title: Bindings +weight: 15 +--- diff --git a/markdown/docs/reference/bindings/index.md b/markdown/docs/reference/bindings/index.md new file mode 100644 index 000000000000..314c533f0ae4 --- /dev/null +++ b/markdown/docs/reference/bindings/index.md @@ -0,0 +1,18 @@ +--- +title: Overview +weight: 15 +--- + +## Overview + +import BindingsOverview from '../../../../assets/docs/fragments/bindings-overview.md' + + + +## 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).