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

Update README.md to add Project design.md #189

Merged
merged 11 commits into from
Jul 22, 2022
Merged

Update README.md to add Project design.md #189

merged 11 commits into from
Jul 22, 2022

Conversation

xellos00
Copy link
Member

@xellos00 xellos00 commented Jul 20, 2022

  • added design.md

1. Type of change

Please delete options that are not relevant.

  • New feature
  • Enhancement
  • Bug/fix (non-breaking change which fixes an issue)
  • others (anything other than above)

2. Summary

Please include a summary of the changes and which issue is fixed or solved.

close #151

This is a PR for #151 which demonstrate
VATZ project design AS-IS and Short term of To-BE


3. Comments

Please, leave a comments if there's further action that requires.

README.md Outdated Show resolved Hide resolved
docs/design.md Outdated Show resolved Hide resolved
@xellos00 xellos00 requested review from gnongs and heejin-github July 20, 2022 07:18
Copy link
Member

@heejin-github heejin-github left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@xellos00 xellos00 requested a review from hqueue July 21, 2022 02:00
Copy link
Member

@gnongs gnongs left a 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.
Copy link
Member

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.

Copy link
Member Author

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Related to above comment.

Copy link
Member Author

@xellos00 xellos00 Jul 22, 2022

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.

Copy link
Member

@hqueue hqueue left a 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 :)

Copy link
Member

@meetrick meetrick left a 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

Copy link
Member

@kim201212 kim201212 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

README.md Outdated Show resolved Hide resolved
docs/design.md Outdated Show resolved Hide resolved
docs/design.md Outdated Show resolved Hide resolved
xellos00 added 2 commits July 21, 2022 20:10
in design.md
and Update some typos
in design.md
and Update some typos
@xellos00 xellos00 merged commit 72ada77 into dsrvlabs:main Jul 22, 2022
@xellos00 xellos00 deleted the issue-151 branch July 22, 2022 02:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2. Documentation for Vatz Project Design
8 participants