Skip to content

User Documentation of VDK Notebook #1844

@antoniivanov

Description

@antoniivanov

What is the feature request? What problem does it solve?

Having clear and concise documentation is essential for new users who want to quickly get started with the Jupyter integration.

Suggested solution
I would like to request that the user documentation for the VDK Jupyter integration be improved and updated to follow the coding standard for README.md files, as outlined in the VDK wiki. https://github.com/vmware/versatile-data-kit/wiki/Coding-Standard#readme-files

Acceptance Criteria

  • Update the user documentation for Jupyter to follow the coding standard for README.md files.
  • Provide clear instructions on how to set up and use the integration, including how to install the necessary plugins and dependencies, and how to run jobs and manage data assets.
  • Include examples and screenshots to help users better understand how to use the integration.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/plugin/vdk-notebookA plugin which enables VDK to work with notebook filesenhancementNew feature or requestinitiative: VDK Notebooks AlphaThis is all the work to accomplish the VDK notebooks alpha integrationstoryTask for an Epic

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions