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

Protocol server data flow diagram #98

Open
2 tasks
vishi24 opened this issue Mar 7, 2024 · 1 comment
Open
2 tasks

Protocol server data flow diagram #98

vishi24 opened this issue Mar 7, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation protocol server protocol server

Comments

@vishi24
Copy link
Contributor

vishi24 commented Mar 7, 2024

Description

Current documentation lacks a proper data flow diagram that clearly depicts what are the checks and how data flow happens in protocol server.Need to create a proper flow diagram that will show all possibles routes a request to protocol server can take also mention the conditions. The components in the diagram should contain -
1.validations in code
2.Redis
3.rabbitmq
4.MongoDB
5.Webhook

Once this is done, it should be part of the main readme file , add it after the architecture diagram with heading "Data flow diagram"

Attaching a sample
image

Resources that can be used is available here

Goals

  • A document explaining the flow of data along with the validations/checks at the program and DB level.

Expected Outcome

A document with expected diagram and proper explanation of the diagram.

Acceptance Criteria

  • A document that is self explanatory about the data flow in protocol server.

Implementation Details

image

Mockups / Wireframes

NA


Product Name

Protocol server

Project Name

Protocol server

Tech Skills Needed:

node js

Complexity

medium

Category

Documentation

Sub Category

NA

@vishi24 vishi24 added the documentation Improvements or additions to documentation label Mar 7, 2024
@vishi24 vishi24 added the protocol server protocol server label Mar 8, 2024
@shreyvishal
Copy link
Contributor

Image
Image
Image
Image

Have asked @vishi24 to review on 15th March

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation protocol server protocol server
Projects
None yet
Development

No branches or pull requests

2 participants