From e80380b3c9552305aa60f17a5ab8c3a854723945 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Thu, 29 Sep 2022 13:37:33 -0700 Subject: [PATCH 01/13] NEW concept doc: application, Draft 1 --- pages/docs/concepts/application.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 pages/docs/concepts/application.md diff --git a/pages/docs/concepts/application.md b/pages/docs/concepts/application.md new file mode 100644 index 000000000000..f1fdcd708efa --- /dev/null +++ b/pages/docs/concepts/application.md @@ -0,0 +1,23 @@ +--- +title: Application +weight: 20 +--- + + +## What is an application? +An application is any computer program or a group of them. + +An application could also be a micro-service, IoT device (sensor), mainframe process, etc. Users may even write applications in different programming languages if they support one of the selected protocols. + +## What is the purpose of an application? +In Event-Driven Architecture (EDA), an application must be a producer, a consumer, or both. Applications must also use the protocols the server supports if they wish to connect and exchange messages. + +### Applications: producers and consumers +```mermaid +flowchart LR + A[PRODUCER application] --> B[message] + B --> C[channel] + C --> D[message] + D --> F[CONSUMER application] +``` +The diagram above describes a bi-directional communication between a **producer application** and a **consumer application**. In this case, in your AsyncAPI file, you describe the `channel` via the [`Channel Bindings Object`](https://www.asyncapi.com/docs/reference/specification/v2.4.0#channelBindingsObject), which describes the protocol-specific definitions for `channel`s. \ No newline at end of file From b1f90ecff198586e97cf03dfcd223a0f5e54ca1c Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Fri, 30 Sep 2022 07:40:38 -0700 Subject: [PATCH 02/13] removed bidirectional communication mention --- pages/docs/concepts/application.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/concepts/application.md b/pages/docs/concepts/application.md index f1fdcd708efa..db7ab56679a2 100644 --- a/pages/docs/concepts/application.md +++ b/pages/docs/concepts/application.md @@ -20,4 +20,4 @@ flowchart LR C --> D[message] D --> F[CONSUMER application] ``` -The diagram above describes a bi-directional communication between a **producer application** and a **consumer application**. In this case, in your AsyncAPI file, you describe the `channel` via the [`Channel Bindings Object`](https://www.asyncapi.com/docs/reference/specification/v2.4.0#channelBindingsObject), which describes the protocol-specific definitions for `channel`s. \ No newline at end of file +The diagram above describes the communication between a **producer application** and a **consumer application**. In this case, in your AsyncAPI file, you describe the `channel` via the [`Channel Bindings Object`](https://www.asyncapi.com/docs/reference/specification/v2.4.0#channelBindingsObject), which describes the protocol-specific definitions for `channel`s. From 1b898fbab912cefa210d3f380ed09cc9ebfcf1b8 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Wed, 5 Oct 2022 11:25:05 -0700 Subject: [PATCH 03/13] fixed heading question for cohesion --- pages/docs/concepts/application.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/concepts/application.md b/pages/docs/concepts/application.md index db7ab56679a2..da88ddef53ec 100644 --- a/pages/docs/concepts/application.md +++ b/pages/docs/concepts/application.md @@ -9,7 +9,7 @@ An application is any computer program or a group of them. An application could also be a micro-service, IoT device (sensor), mainframe process, etc. Users may even write applications in different programming languages if they support one of the selected protocols. -## What is the purpose of an application? +## Why do we need applications? In Event-Driven Architecture (EDA), an application must be a producer, a consumer, or both. Applications must also use the protocols the server supports if they wish to connect and exchange messages. ### Applications: producers and consumers From 1d459eca99ffe52670f7c81f18adb375bf26a567 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Mon, 17 Oct 2022 17:08:08 -0700 Subject: [PATCH 04/13] Update pages/docs/concepts/application.md Co-authored-by: Lukasz Gornicki --- pages/docs/concepts/application.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/concepts/application.md b/pages/docs/concepts/application.md index da88ddef53ec..63e15b310e92 100644 --- a/pages/docs/concepts/application.md +++ b/pages/docs/concepts/application.md @@ -14,7 +14,7 @@ In Event-Driven Architecture (EDA), an application must be a producer, a consume ### Applications: producers and consumers ```mermaid -flowchart LR +flowchart TD A[PRODUCER application] --> B[message] B --> C[channel] C --> D[message] From 6db0a632fbc74d0b4d7e50855c3978f0df4fe8b1 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Mon, 17 Oct 2022 17:10:49 -0700 Subject: [PATCH 05/13] Update pages/docs/concepts/application.md Co-authored-by: Lukasz Gornicki --- pages/docs/concepts/application.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/concepts/application.md b/pages/docs/concepts/application.md index 63e15b310e92..d27a35532707 100644 --- a/pages/docs/concepts/application.md +++ b/pages/docs/concepts/application.md @@ -20,4 +20,4 @@ flowchart TD C --> D[message] D --> F[CONSUMER application] ``` -The diagram above describes the communication between a **producer application** and a **consumer application**. In this case, in your AsyncAPI file, you describe the `channel` via the [`Channel Bindings Object`](https://www.asyncapi.com/docs/reference/specification/v2.4.0#channelBindingsObject), which describes the protocol-specific definitions for `channel`s. +The diagram above describes the communication between a **PRODUCER application** and a **CONSUMER application**. From 63cb0fb84cef80fea708e1afe4ce0cd96999b7aa Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Tue, 18 Oct 2022 15:52:21 -0700 Subject: [PATCH 06/13] adding more context on application --- pages/docs/concepts/application.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/pages/docs/concepts/application.md b/pages/docs/concepts/application.md index d27a35532707..faf5924af980 100644 --- a/pages/docs/concepts/application.md +++ b/pages/docs/concepts/application.md @@ -20,4 +20,8 @@ flowchart TD C --> D[message] D --> F[CONSUMER application] ``` -The diagram above describes the communication between a **PRODUCER application** and a **CONSUMER application**. +The above diagram describes a message communication traveling through a channel between a **PRODUCER application** and a **CONSUMER application**. + + +When writing your AsyncAPI document, make sure to describe what a user can do with your application; not what the application does. In other words, if your application is a `producer`, your AsyncAPI document should describe where users can subscribe to your producer application. + From c950bb2ed0bcd86a1e433e72fbf4c5ae03b18968 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Tue, 18 Oct 2022 15:53:36 -0700 Subject: [PATCH 07/13] styling fix --- pages/docs/concepts/application.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/concepts/application.md b/pages/docs/concepts/application.md index faf5924af980..7d3da06105a5 100644 --- a/pages/docs/concepts/application.md +++ b/pages/docs/concepts/application.md @@ -10,7 +10,7 @@ An application is any computer program or a group of them. An application could also be a micro-service, IoT device (sensor), mainframe process, etc. Users may even write applications in different programming languages if they support one of the selected protocols. ## Why do we need applications? -In Event-Driven Architecture (EDA), an application must be a producer, a consumer, or both. Applications must also use the protocols the server supports if they wish to connect and exchange messages. +In Event-Driven Architecture (EDA), an application must be a `producer`, a `consumer`, or both. Applications must also use the protocols the server supports if they wish to connect and exchange messages. ### Applications: producers and consumers ```mermaid From c2157ab7ef7be102c42716a39b4b4006b70ff8d6 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Tue, 18 Oct 2022 15:56:05 -0700 Subject: [PATCH 08/13] more styling changes --- pages/docs/concepts/application.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/concepts/application.md b/pages/docs/concepts/application.md index 7d3da06105a5..808e30771745 100644 --- a/pages/docs/concepts/application.md +++ b/pages/docs/concepts/application.md @@ -23,5 +23,5 @@ flowchart TD The above diagram describes a message communication traveling through a channel between a **PRODUCER application** and a **CONSUMER application**. -When writing your AsyncAPI document, make sure to describe what a user can do with your application; not what the application does. In other words, if your application is a `producer`, your AsyncAPI document should describe where users can subscribe to your producer application. +When writing your AsyncAPI document, make sure to describe what a user can do with your application; not what the application does. In other words, if your application is a producer, your AsyncAPI document should describe where users can subscribe to your producer application. From 6f5548b97b70e6ad8f4efc7a63f2bd142fc0eac7 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Thu, 20 Oct 2022 18:54:26 -0700 Subject: [PATCH 09/13] Update pages/docs/concepts/application.md Co-authored-by: Lukasz Gornicki --- pages/docs/concepts/application.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/concepts/application.md b/pages/docs/concepts/application.md index 808e30771745..b77e949c8562 100644 --- a/pages/docs/concepts/application.md +++ b/pages/docs/concepts/application.md @@ -23,5 +23,5 @@ flowchart TD The above diagram describes a message communication traveling through a channel between a **PRODUCER application** and a **CONSUMER application**. -When writing your AsyncAPI document, make sure to describe what a user can do with your application; not what the application does. In other words, if your application is a producer, your AsyncAPI document should describe where users can subscribe to your producer application. +When writing your AsyncAPI document, make sure to describe what a user can do with your application; not what the application does. In other words, if your application is a producer, your AsyncAPI document should describe where users can subscribe to messages produced by your producer application. From 41ff5aa9004490ffd4c775491ee720faa67a6a10 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Tue, 25 Oct 2022 19:06:53 -0700 Subject: [PATCH 10/13] fixing incorrect statement about messages --- pages/docs/concepts/application.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/concepts/application.md b/pages/docs/concepts/application.md index b77e949c8562..060363cb4387 100644 --- a/pages/docs/concepts/application.md +++ b/pages/docs/concepts/application.md @@ -23,5 +23,5 @@ flowchart TD The above diagram describes a message communication traveling through a channel between a **PRODUCER application** and a **CONSUMER application**. -When writing your AsyncAPI document, make sure to describe what a user can do with your application; not what the application does. In other words, if your application is a producer, your AsyncAPI document should describe where users can subscribe to messages produced by your producer application. +When writing your AsyncAPI document, make sure to describe what a user can do with your application; not what the application does. In other words, if your application is a producer, your AsyncAPI document should describe where users can subscribe to, to receive messages produced by your producer application. From 07528b58ef246bd2fc3e6ddeb714d985aed816b8 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Mon, 7 Nov 2022 12:58:20 -0800 Subject: [PATCH 11/13] added prev next buttons --- pages/docs/concepts/application.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/pages/docs/concepts/application.md b/pages/docs/concepts/application.md index 060363cb4387..b26b7f0ebdc5 100644 --- a/pages/docs/concepts/application.md +++ b/pages/docs/concepts/application.md @@ -1,6 +1,6 @@ --- title: Application -weight: 20 +weight: 23 --- @@ -25,3 +25,18 @@ The above diagram describes a message communication traveling through a channel When writing your AsyncAPI document, make sure to describe what a user can do with your application; not what the application does. In other words, if your application is a producer, your AsyncAPI document should describe where users can subscribe to, to receive messages produced by your producer application. + + From 0ec54f6ac1df12e7c8be3ae90702dc9309b503e3 Mon Sep 17 00:00:00 2001 From: Akshat Nema <76521428+akshatnema@users.noreply.github.com> Date: Tue, 6 Dec 2022 13:35:32 +0530 Subject: [PATCH 12/13] Update pages/docs/concepts/application.md --- pages/docs/concepts/application.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/concepts/application.md b/pages/docs/concepts/application.md index b26b7f0ebdc5..1f8aafc05b87 100644 --- a/pages/docs/concepts/application.md +++ b/pages/docs/concepts/application.md @@ -34,7 +34,7 @@ When writing your AsyncAPI document, make sure to describe what a user can do wi type:'back', }, { - href: '/docs/concepts', + href: '/docs/concepts/protocol', title: 'Protocol', type:'next', } From 36879a536e0224d875f5bad6c79708b021f816c2 Mon Sep 17 00:00:00 2001 From: akshatnema <20bcs022@iiitdmj.ac.in> Date: Tue, 6 Dec 2022 13:47:06 +0530 Subject: [PATCH 13/13] certain changes made --- pages/docs/concepts/channel.md | 4 ++-- pages/docs/concepts/message.md | 4 ++-- pages/docs/concepts/protocol.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/pages/docs/concepts/channel.md b/pages/docs/concepts/channel.md index a44468ff4fa6..44a30bdd2376 100644 --- a/pages/docs/concepts/channel.md +++ b/pages/docs/concepts/channel.md @@ -30,9 +30,9 @@ The diagram above shows the communication between a `producer` and `consumer`, w title: 'Consumer', }, { - href:'/docs/concepts/message', + href:'/docs/concepts/application', type: 'next', - title: 'Message', + title: 'Application', } ]} /> diff --git a/pages/docs/concepts/message.md b/pages/docs/concepts/message.md index dd39f30a4a34..37c90b95844b 100644 --- a/pages/docs/concepts/message.md +++ b/pages/docs/concepts/message.md @@ -38,9 +38,9 @@ Overall, `events` are `messages` but not all `messages` are `events`. \ No newline at end of file