Skip to content

Commit

Permalink
documentation: VDK components explained (#1865)
Browse files Browse the repository at this point in the history
What does VDK do? Explain VDK SDK being a powerful Data Framework. Soft
landing to the rest of the documentation.

I've added a logo per component, along with a clear explanation of what
it does. I have also added subcomponents and their purpose.

Testing done:

https://www.canva.com/design/DAFfO0_vC6g/vX3O0yYOc1nTcPuoBlp6qQ/edit?utm_content=DAFfO0_vC6g&utm_campaign=designshare&utm_medium=link2&utm_source=sharebutton

---------

Signed-off-by: ivakoleva <[email protected]>
  • Loading branch information
ivakoleva authored Apr 25, 2023
1 parent ebdd6cb commit 784bacc
Show file tree
Hide file tree
Showing 14 changed files with 43 additions and 7 deletions.
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): .*
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,41 @@ 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

<p>
<img src="./support/images/components/VDK SDK.svg" width="600" />
</p>
<p>
<img src="./support/images/components/VDK SDK modules (1).svg" width="300"/>
<img src="./support/images/components/VDK SDK modules (2).svg" width="300"/>
<img src="./support/images/components/VDK SDK modules (3).svg" width="300"/>
<img src="./support/images/components/VDK SDK modules (4).svg" width="300"/>
<img src="./support/images/components/VDK SDK modules (5).svg" width="300"/>
<img src="./support/images/components/VDK SDK modules (6).svg" width="300"/>
<img src="./support/images/components/VDK SDK modules (7).svg" width="300"/>
</p>

<p>
<img src="./support/images/components/VDK CLI.svg" width="600"/>
</p>


<!-- 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/>
-->
<p>
<img src="./support/images/components/Control Service.svg" width="600"/>
</p>
<p>
<img src="./support/images/components/Control Service modules (1).svg" width="300"/>
<img src="./support/images/components/Control Service modules (2).svg" width="300"/>
</p>


# 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
1 change: 1 addition & 0 deletions support/images/components/Control Service modules (1).svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions support/images/components/Control Service modules (2).svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions support/images/components/Control Service.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions support/images/components/VDK CLI.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions support/images/components/VDK SDK modules (1).svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions support/images/components/VDK SDK modules (2).svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions support/images/components/VDK SDK modules (3).svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions support/images/components/VDK SDK modules (4).svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions support/images/components/VDK SDK modules (5).svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions support/images/components/VDK SDK modules (6).svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions support/images/components/VDK SDK modules (7).svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions support/images/components/VDK SDK.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 784bacc

Please sign in to comment.