You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add getting started section for quickstart-vdk and ui
What
Add getting started section for quickstart-vdk and ui. Section
gives an overview on how to get started with just vdk-core and
quickstart-vdk. It's meant as a brief overview and links to more
in-depth guides, e.g. wiki and videos
Why
README.md is the front page of the vdk project and it
lacks a good getting started section. The current getting
started section just links to the wiki.
How was this tested
n/a
What kind of chenge is this
docs
Copy file name to clipboardExpand all lines: README.md
+43-1Lines changed: 43 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -102,11 +102,53 @@ A preview of the VDK CLI commands:
102
102
103
103
104
104
# Getting Started
105
-
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.
105
+
106
+
## Create and run data jobs locally
107
+
108
+
```
109
+
pip install quickstart-vdk
110
+
```
111
+
112
+
This installs the core vdk packages and the vdk command line interface. You can
113
+
use them to run jobs in your local shell environment.
-[Running in production](https://github.com/vmware/versatile-data-kit/wiki/Installation#install-versatile-data-kit-control-service)
110
152
- Read the article about [using the Versatile Data Kit and Trino DB](https://towardsdatascience.com/from-raw-data-to-a-cleaned-database-a-deep-dive-into-versatile-data-kit-ab5fd992a02e).
111
153
- Join us at a [community meeting](https://github.com/vmware/versatile-data-kit/wiki/Community-and-Resources)
0 commit comments