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

documentation: VDK components explained #1865

Merged
merged 6 commits into from
Apr 25, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
2 changes: 1 addition & 1 deletion .gitlint
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ contrib=contrib-body-requires-signed-off-by
# commit-msg title must be matched to.
# Note that the regex can contradict with other rules if not used correctly
# (e.g. title-must-not-contain-word).
regex=(vdk-.*|versatile-data-kit|control-service|examples|frontend): .*
regex=(vdk-.*|versatile-data-kit|documentation|control-service|examples|frontend): .*
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,32 @@ VDK creates data processing workflows to:
![Without / With Versatile Data Kit code](./support/images/versatile-data-kit-before-after-code-transparent-dark.svg#gh-dark-mode-only)


# Versatile Data Kit Components
- Software Development Kit (SDK):
- Tools to automate the extraction, transformation, and loading of data.
- A plugin framework that allows users to extend the framework according to their specific requirements.
- Control Service: The Control Service allows users to create, deploy, manage, and execute data jobs in a Kubernetes runtime environment.
# What VDK can do
Review images to be added in [TEXTBOX]:
https://www.canva.com/design/DAFfO0_vC6g/vX3O0yYOc1nTcPuoBlp6qQ/edit?utm_content=DAFfO0_vC6g&utm_campaign=designshare&utm_medium=link2&utm_source=sharebutton
Each image will be a link to a dedicated Wiki page.
TODO: export those to SVGs




# [VDK SDK]
[Properties] [Job Arguments] [Managed Connections] [Data Ingesters] [Templates] [Plugin API] [Plugin Registry]

<!-- TODO: [[VDK CLI]](link to wiki page) -->
# [VDK CLI]

<!-- This is going to be transferred to the VDK CLI page to be linked:
A preview of the VDK CLI commands:
- `vdk create`
- `vdk run`
- `vdk deploy`<br>
<br> <img alt="Gif displaying Versatile Data Kit commands create, run and deploy" src="https://github.com/vmware/versatile-data-kit/blob/main/support/images/versatile-data-kit-cli-retail.gif" width=80% height=auto />
<br> <img alt="Gif displaying Versatile Data Kit commands create, run and deploy" src="https://github.com/vmware/versatile-data-kit/blob/main/support/images/versatile-data-kit-cli-retail.gif" width=80% height=auto/>
-->

# [Control Service]
[Swagger UI] [Frontend UI]


# Getting Started
Installing VDK is a simple pip command. See the [Getting Started](https://github.com/vmware/versatile-data-kit/wiki/getting-started) guide to install VDK and create a data job.
Expand Down