-
Notifications
You must be signed in to change notification settings - Fork 15
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
Update README.md to add Project design.md #189
Conversation
- added design.md
line num # 57
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍🏻
docs/design.md
Outdated
|
||
![Vatz Diagram (To be) drawio (2)](https://user-images.githubusercontent.com/6308023/179885451-6d40505b-8b31-41d3-8dff-25220e00be1c.png) | ||
|
||
> **VATZ** is mainly designed to check the node status in real time and get the alert notification of all blockchain protocols, including metrics that doesn't supported by protocol itself. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some comment. I think when we started VATZ
, VATZ
is not just a monitoring tool but will also automate node management too in long-term future. Is it still valid or narrowed down to monitoring tool?
If VATZ will/can manage node too in future, please elaborate this paragraph. For example, ..., In future, we expect VATZ will help node operator to automate node operation in addition to monitoring.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just updated over all as below with mentioning upcoming features that is targeting both of the monitoring and the automation.
... supported by the protocol itself. Features for helping node operators such as automation that enable node manage orchestration and controlling VATZ over CLI commands are going to be available in near future.
docs/design.md
Outdated
|
||
## Proto Repository (gRPC protocols) | ||
|
||
VATZ is a total node management tool that is designed to be customizable and expandable through plug-in from the initial design stage. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Related to above comment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I simply describe general ideas of VATZ and mainly focused on emphasizing using gRPC is enable to develop plugins with language you want and I so prefer extra comments for upcoming features stay on top paragraph only.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM and also left some comment :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Look good to mee
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM :)
- design.md - line num # 27 - line num # 53 - README.md - line num # 25
in design.md and Update some typos
in design.md and Update some typos
1. Type of change
Please delete options that are not relevant.
2. Summary
close #151
This is a PR for #151 which demonstrate
VATZ project design AS-IS and Short term of To-BE
3. Comments