Skip to content

Commit fe4e565

Browse files
Documentation: README components image changes (#2330)
This PR is 1. Replacing the components to take less space. 2. Replacing the Without and With VDK image with CLI GIF 3. Restructuring the Resources, as per the feedback that in the Next steps should be the Getting Started link and just reshuffle the resources in a better chronological order + add corresponding emojis --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 6dde4bb commit fe4e565

File tree

3 files changed

+16
-40
lines changed

3 files changed

+16
-40
lines changed

README.md

Lines changed: 14 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -58,48 +58,21 @@ VDK creates data processing workflows to:
5858
- Provide built-in monitoring and smart notification capabilities.
5959
- Track both code and data modifications and the relationship between them, allowing quicker troubleshooting and version rollback.
6060

61+
<!-- This is going to be transferred to the VDK CLI page to be linked: -->
62+
### A preview of the VDK CLI commands:
63+
- `vdk create`
64+
- `vdk run`
65+
- `vdk deploy`<br>
66+
<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/>
6167

62-
![Without / With Versatile Data Kit](./support/images/versatile-data-kit-before-after-img-transparent-light.svg#gh-light-mode-only)
63-
![Without / With Versatile Data Kit](./support/images/versatile-data-kit-before-after-img-transparent-dark.svg#gh-dark-mode-only)
6468
![Without / With Versatile Data Kit code](./support/images/versatile-data-kit-before-after-code-transparent-light.svg#gh-light-mode-only)
6569
![Without / With Versatile Data Kit code](./support/images/versatile-data-kit-before-after-code-transparent-dark.svg#gh-dark-mode-only)
6670

6771

68-
# What VDK can do
69-
70-
<p>
71-
<img src="./support/images/components/VDK SDK.svg" width="600" />
72-
</p>
73-
<p>
74-
<img src="./support/images/components/VDK SDK modules (1).svg" width="300"/>
75-
<img src="./support/images/components/VDK SDK modules (2).svg" width="300"/>
76-
<img src="./support/images/components/VDK SDK modules (3).svg" width="300"/>
77-
<img src="./support/images/components/VDK SDK modules (4).svg" width="300"/>
78-
<img src="./support/images/components/VDK SDK modules (5).svg" width="300"/>
79-
<img src="./support/images/components/VDK SDK modules (6).svg" width="300"/>
80-
<img src="./support/images/components/VDK SDK modules (7).svg" width="300"/>
81-
</p>
82-
83-
<p>
84-
<img src="./support/images/components/VDK CLI.svg" width="600"/>
85-
</p>
86-
87-
88-
<!-- This is going to be transferred to the VDK CLI page to be linked:
89-
A preview of the VDK CLI commands:
90-
- `vdk create`
91-
- `vdk run`
92-
- `vdk deploy`<br>
93-
<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/>
94-
-->
95-
<p>
96-
<img src="./support/images/components/Control Service.svg" width="600"/>
97-
</p>
98-
<p>
99-
<img src="./support/images/components/Control Service modules (1).svg" width="300"/>
100-
<img src="./support/images/components/Control Service modules (2).svg" width="300"/>
101-
</p>
72+
# VDK components
10273

74+
![VDK Components](./support/images/versatile-data-kit-components-dark-1.svg#gh-dark-mode-only)
75+
![VDK Components](./support/images/versatile-data-kit-components-light-1.svg#gh-light-mode-only)
10376

10477
# Getting Started
10578

@@ -138,14 +111,15 @@ them.
138111

139112
# Next Steps
140113

141-
▶️ [Getting started with VDK Operations UI](https://www.youtube.com/watch?v=DLRGCCGUp0U)</br>
142-
📖 [Use case examples](https://github.com/vmware/versatile-data-kit/wiki/Examples) that show how VDK fits into the data workflow.</br>
143-
📖 [VDK with Trino DB](https://towardsdatascience.com/from-raw-data-to-a-cleaned-database-a-deep-dive-into-versatile-data-kit-ab5fd992a02e).</br>
114+
🏃 [Getting Started](https://github.com/vmware/versatile-data-kit/wiki/getting-started)</br>
115+
📖 [VDK Examples](https://github.com/vmware/versatile-data-kit/wiki/Examples) try VDK yourself</br>
116+
🪜 [A step-by-step guide building a Web App with Streamlit and VDK](https://towardsdatascience.com/how-to-build-a-web-app-with-data-ingested-through-versatile-data-kit-ddae43b5f62d](https://towardsdatascience.com/how-to-build-a-web-app-with-data-ingested-through-versatile-data-kit-ddae43b5f62d )</br>
117+
▶️ [VDK UI - Installation and Getting Started](https://www.youtube.com/watch?v=DLRGCCGUp0U)</br>
144118
🗣️ Get to know us and ask questions at our [community meeting](https://github.com/vmware/versatile-data-kit/wiki/Community-and-Resources)</br>
145119

146120
# Additional Resources
121+
🔍 [Documentation](https://github.com/vmware/versatile-data-kit/wiki/Introduction) for VDK.</br>
147122
📖 [Running in production](https://github.com/vmware/versatile-data-kit/wiki/Installation#install-versatile-data-kit-control-service)</br>
148-
📖 [Documentation](https://github.com/vmware/versatile-data-kit/wiki/Introduction) for VDK.</br>
149123
▶️ [VDK Operations UI Overview](https://www.youtube.com/watch?v=9BkAOSvXuUg)</br>
150124

151125
# Contributing

support/images/versatile-data-kit-components-dark-1.svg

Lines changed: 1 addition & 0 deletions
Loading

support/images/versatile-data-kit-components-light-1.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)