-
Notifications
You must be signed in to change notification settings - Fork 59
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
jupyter-vep: Expand details on extensions design #1304
Conversation
Please avoid generic titles like "changes on README.md" - I mean every single change on readme could have this title. Let's be explicit, what is the change? E.g "Expand details on extensions design" or something similar. |
|
||
### VDK JupyterLab extension | ||
This extension will be both front-end and server side extension for JupyterLab. | ||
The front-end side will be introducing the graphical elements such as menus, buttons, etc. and will be responsible with sending |
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.
I missed saying that since it can be done at follow-up PR when you have better idea about these things
But we need to be very explicit here.
What are the exact graphical elements that would be introduced. Having mockup picture would be a huge bonus .
What are the exact request that would be sent and what commands would be supported?
Also there's a lot of assumption about what the reader knows and not everyone reading this would know how VDK works and what is file step plugin and etc , so you need either describe or better link to existing documentation that explain concepts you are using.
What: Changed the high level design diagram
Why:
Since introducing VDK variables directly is not a high level requirement the iPython package module should be removed from the VEP's high level design. The new diagram for the High level design is much more accurate and gives a better idea of what the changes will be.
The iPython package with the VDK variables can be introduces later on as an enhancement but should not have a place in the bigger picture of VDK Jupyter Integration.
Signed-off-by: Duygu Hasan [email protected]