Skip to content
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

Merged
merged 16 commits into from
Sep 19, 2023

Conversation

duyguHsnHsn
Copy link
Collaborator

@duyguHsnHsn duyguHsnHsn commented Aug 3, 2023

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

@yonitoo
Copy link
Contributor

yonitoo commented Aug 3, 2023

Would it be possible to add some images here?

@duyguHsnHsn
Copy link
Collaborator Author

@antoniivanov
Copy link
Collaborator

To reduce the image sizes:

  • Reduce the size of each image. Do we need 1900x1000 image? Considering it's part of a notebook where we have only xbyY size anyway. Maybe approximately 1000x500 would be enough
  • JPEG (instead of png) format would generally result in smaller images . Alternatively, use indexed PNG . Also I personally have not really used WebP but it's a modern format that may provide more optimal images.
  • Alternatively SVG might be better if feasible.
  • Consider gifs - which would allow you to combine multiple images in one animation. That may be better user experience ?
  • There are some websites to optimize images like https://compressor.io/, https://tinypng.com/

@duyguHsnHsn duyguHsnHsn changed the title vdk-jupyter:add first version of getting started page[DRAFT] vdk-jupyter: add first version of getting started page[DRAFT] Aug 8, 2023
@murphp15
Copy link
Collaborator

murphp15 commented Aug 9, 2023

Can you update the images so they don't say locally and in the cloud.

@antoniivanov
Copy link
Collaborator

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.

@duyguHsnHsn
Copy link
Collaborator Author

I have created a miro board i will include it in the PR when it is ready

@duyguHsnHsn duyguHsnHsn marked this pull request as ready for review September 7, 2023 11:11
@duyguHsnHsn duyguHsnHsn changed the title vdk-jupyter: add first version of getting started page[DRAFT] vdk-jupyter: add first version of getting started page Sep 7, 2023
Copy link

@sabadzhiev sabadzhiev left a 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' 🙂 .

Copy link
Collaborator

@antoniivanov antoniivanov left a 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

@duyguHsnHsn duyguHsnHsn enabled auto-merge (squash) September 19, 2023 08:06
@duyguHsnHsn duyguHsnHsn merged commit 80de548 into main Sep 19, 2023
7 of 8 checks passed
@duyguHsnHsn duyguHsnHsn deleted the person/hduygu/vdk-jupyter-getting-started branch September 19, 2023 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants