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: load data before vdk operations #1762

Merged
merged 11 commits into from
Mar 21, 2023

Conversation

duyguHsnHsn
Copy link
Collaborator

@duyguHsnHsn duyguHsnHsn commented Mar 21, 2023

What:
Load data to jobData and UI components before rendering them by getting the job data from current working directory and config.ini file if it exists.

Example how deploy job component is rendered when we are in /rest-api-job directory with config.ini file:
Screenshot 2023-03-21 at 10 22 20

Why: Loading data before rendering the UI components reduces the need for manual input, saving time and effort for users who need to interact with job data. The interface can better adapt to the specific needs and requirements of each user. This automatic data population minimizes the risk of input errors and helps users quickly access the information they need.

Tests: jest tests

Signed-off-by: Duygu Hasan hduygu@vmware.com

@antoniivanov
Copy link
Collaborator

Please link github issue

@antoniivanov
Copy link
Collaborator

Why: To make the Jupyter UI more user-friendly.

Please, try to be more detailed in the why section. Why it would make it more user-friendly (quick advice - learn to self-employ the 5 whys method - https://en.wikipedia.org/wiki/Five_whys)

If this explanation is in another place (like VEP or Github issue, then just link to it.)

In this case, I'd say:
Loading data before rendering the UI components reduces the need for manual input, saving time and effort for users who need to interact with job data. The interface can better adapt to the specific needs and requirements of each user. This automatic data population minimizes the risk of input errors and helps users quickly access the information they need.

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 good to me. This time I spent a bit more time around code quality (which was mostly me learning about TypeScript thanks to https://www.typescriptlang.org/docs/handbook - that's handy) and hence I made some suggestions for improvements.

@duyguHsnHsn duyguHsnHsn enabled auto-merge (squash) March 21, 2023 16:26
@duyguHsnHsn duyguHsnHsn merged commit 9fb7259 into main Mar 21, 2023
@duyguHsnHsn duyguHsnHsn deleted the person/hduygu/vdk-jupyter-read-data-from-config branch March 21, 2023 16:29
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

5 participants