diff --git a/.gitlint b/.gitlint index dc0d25e7c9..32e2d0a21e 100644 --- a/.gitlint +++ b/.gitlint @@ -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): .* diff --git a/README.md b/README.md index ddaa6b0de2..d60d1e5c41 100644 --- a/README.md +++ b/README.md @@ -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 +

+ +

+

+ + + + + + + +

+ +

+ +

+ + + +

+ +

+

+ + +

+ # 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. diff --git a/support/images/components/Control Service modules (1).svg b/support/images/components/Control Service modules (1).svg new file mode 100644 index 0000000000..bbc740f01a --- /dev/null +++ b/support/images/components/Control Service modules (1).svg @@ -0,0 +1 @@ + diff --git a/support/images/components/Control Service modules (2).svg b/support/images/components/Control Service modules (2).svg new file mode 100644 index 0000000000..6a76ebef11 --- /dev/null +++ b/support/images/components/Control Service modules (2).svg @@ -0,0 +1 @@ + diff --git a/support/images/components/Control Service.svg b/support/images/components/Control Service.svg new file mode 100644 index 0000000000..29abaafa37 --- /dev/null +++ b/support/images/components/Control Service.svg @@ -0,0 +1 @@ + diff --git a/support/images/components/VDK CLI.svg b/support/images/components/VDK CLI.svg new file mode 100644 index 0000000000..a0094178f4 --- /dev/null +++ b/support/images/components/VDK CLI.svg @@ -0,0 +1 @@ + diff --git a/support/images/components/VDK SDK modules (1).svg b/support/images/components/VDK SDK modules (1).svg new file mode 100644 index 0000000000..99a0b38031 --- /dev/null +++ b/support/images/components/VDK SDK modules (1).svg @@ -0,0 +1 @@ + diff --git a/support/images/components/VDK SDK modules (2).svg b/support/images/components/VDK SDK modules (2).svg new file mode 100644 index 0000000000..bee682cf66 --- /dev/null +++ b/support/images/components/VDK SDK modules (2).svg @@ -0,0 +1 @@ + diff --git a/support/images/components/VDK SDK modules (3).svg b/support/images/components/VDK SDK modules (3).svg new file mode 100644 index 0000000000..c50a8b7ec4 --- /dev/null +++ b/support/images/components/VDK SDK modules (3).svg @@ -0,0 +1 @@ + diff --git a/support/images/components/VDK SDK modules (4).svg b/support/images/components/VDK SDK modules (4).svg new file mode 100644 index 0000000000..06940315db --- /dev/null +++ b/support/images/components/VDK SDK modules (4).svg @@ -0,0 +1 @@ + diff --git a/support/images/components/VDK SDK modules (5).svg b/support/images/components/VDK SDK modules (5).svg new file mode 100644 index 0000000000..a301827608 --- /dev/null +++ b/support/images/components/VDK SDK modules (5).svg @@ -0,0 +1 @@ + diff --git a/support/images/components/VDK SDK modules (6).svg b/support/images/components/VDK SDK modules (6).svg new file mode 100644 index 0000000000..e7047630f9 --- /dev/null +++ b/support/images/components/VDK SDK modules (6).svg @@ -0,0 +1 @@ + diff --git a/support/images/components/VDK SDK modules (7).svg b/support/images/components/VDK SDK modules (7).svg new file mode 100644 index 0000000000..a07c64e6d6 --- /dev/null +++ b/support/images/components/VDK SDK modules (7).svg @@ -0,0 +1 @@ + diff --git a/support/images/components/VDK SDK.svg b/support/images/components/VDK SDK.svg new file mode 100644 index 0000000000..8e3b90b049 --- /dev/null +++ b/support/images/components/VDK SDK.svg @@ -0,0 +1 @@ +