-
Notifications
You must be signed in to change notification settings - Fork 54
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
vdk-jupyter: add first version of getting started page #2516
Conversation
Would it be possible to add some images here? |
To reduce the image sizes:
|
Can you update the images so they don't say locally and in the cloud. |
How were the images created? It is very important that anyone can edit those images after you without any help. So somewhere (it may be in a README.md) we should have clear instructions and preferably either a link or a source code depending on the tool used which would allow someone else to make changes. |
I have created a miro board i will include it in the PR when it is ready |
…m:vmware/versatile-data-kit into person/hduygu/vdk-jupyter-getting-started
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Duygu,
Looks great. Putting me feedback here(both notes bellow are minor though):
#1: Typo: 'At the core of it, it is a directory with different scripts and inside of it.'
#2: There are a couple of places like: 'WARNING! If this is your initial e....'
This sound more like a tip to me, than a warning. May be, change it to: 'TIP: If this is your initial e....' ... or something not that scaring as 'WARNING' 🙂 .
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty good to me. We can remove the CLI reference in this getting started
What: Created a "Getting Started" page for VDK Jupyter integration.
Why:
A "Getting Started" page serves as a foundational guide for newcomers. By providing clear, step-by-step instructions, we ensure that users can efficiently navigate and leverage the VDK Jupyter integration right from the outset, minimizing potential roadblocks or uncertainties.
Note: You can find the diagrams here: https://miro.com/app/board/uXjVMwyYjto=/?share_link_id=860687647726
Signed-off-by: Duygu Hasan hduygu@vmware.com