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.

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

docs: new concept doc (application) #992

Merged
merged 34 commits into from
Dec 6, 2022
Merged
Changes from 22 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
e80380b
NEW concept doc: application, Draft 1
quetzalliwrites Sep 29, 2022
b1f90ec
removed bidirectional communication mention
quetzalliwrites Sep 30, 2022
4465d8f
Merge branch 'master' into gsod-concept-application
quetzalliwrites Oct 4, 2022
0ea2cd4
Merge branch 'master' into gsod-concept-application
quetzalliwrites Oct 5, 2022
1b898fb
fixed heading question for cohesion
quetzalliwrites Oct 5, 2022
1d459ec
Update pages/docs/concepts/application.md
quetzalliwrites Oct 18, 2022
46dad39
Merge branch 'master' into gsod-concept-application
quetzalliwrites Oct 18, 2022
6db0a63
Update pages/docs/concepts/application.md
quetzalliwrites Oct 18, 2022
32d3d5a
Merge branch 'master' into gsod-concept-application
quetzalliwrites Oct 18, 2022
63cb0fb
adding more context on application
quetzalliwrites Oct 18, 2022
c950bb2
styling fix
quetzalliwrites Oct 18, 2022
c2157ab
more styling changes
quetzalliwrites Oct 18, 2022
4568915
Merge branch 'master' into gsod-concept-application
quetzalliwrites Oct 19, 2022
6f5548b
Update pages/docs/concepts/application.md
quetzalliwrites Oct 21, 2022
6d558b8
Merge branch 'master' into gsod-concept-application
quetzalliwrites Oct 21, 2022
1b98ebf
Merge branch 'master' into gsod-concept-application
quetzalliwrites Oct 25, 2022
fd1c29b
Merge branch 'master' into gsod-concept-application
quetzalliwrites Oct 26, 2022
41ff5aa
fixing incorrect statement about messages
quetzalliwrites Oct 26, 2022
3e4fc61
Merge branch 'master' into gsod-concept-application
quetzalliwrites Oct 26, 2022
e903d17
Merge branch 'master' into gsod-concept-application
quetzalliwrites Oct 27, 2022
8a8db26
Merge branch 'master' into gsod-concept-application
quetzalliwrites Oct 31, 2022
94f2be8
Merge branch 'master' into gsod-concept-application
derberg Nov 3, 2022
fc7f0fb
Merge branch 'master' into gsod-concept-application
quetzalliwrites Nov 4, 2022
d8e54fd
Merge branch 'master' into gsod-concept-application
akshatnema Nov 6, 2022
05659ca
Merge branch 'master' into gsod-concept-application
quetzalliwrites Nov 7, 2022
07528b5
added prev next buttons
quetzalliwrites Nov 7, 2022
599bcf0
Merge branch 'master' into gsod-concept-application
quetzalliwrites Nov 8, 2022
f294ca2
Merge branch 'master' into gsod-concept-application
quetzalliwrites Nov 9, 2022
3ac342d
Merge branch 'master' into gsod-concept-application
quetzalliwrites Nov 15, 2022
81c7603
Merge branch 'master' into gsod-concept-application
quetzalliwrites Dec 3, 2022
a04377a
Merge branch 'master' into gsod-concept-application
quetzalliwrites Dec 6, 2022
b161a07
Merge branch 'master' into gsod-concept-application
derberg Dec 6, 2022
0ec54f6
Update pages/docs/concepts/application.md
akshatnema Dec 6, 2022
36879a5
certain changes made
akshatnema Dec 6, 2022
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
27 changes: 27 additions & 0 deletions pages/docs/concepts/application.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
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.

## 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
```mermaid
flowchart TD
A[PRODUCER application] --> B[message]
B --> C[channel]
C --> D[message]
D --> F[CONSUMER application]
```
The above diagram describes a message communication traveling through a channel between a **PRODUCER application** and a **CONSUMER application**.

<Remember>
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 <em>application</em> is a <b>producer</b>, your AsyncAPI document should describe where users can subscribe to, to receive messages produced by your <b>producer</b> application.
</Remember>