Standardise Jupyter Notebook JSON Formatting for Version Control #2898
Description
What is the feature request? What problem does it solve?
In our current workflow, Jupyter Notebooks can be frequently committed to version control with inconsistent JSON formatting. This may result in significant 'noise' in version control, where changes due to formatting rather than content create confusion. It becomes challenging to track actual changes, hindering code reviews and collaboration. Standardising the JSON formatting of notebooks before deployment would ensure that version control diffs reflect only meaningful content changes, enhancing clarity and efficiency in our development process.
Suggested solution
A module in charge of the formatting of the Notebooks should be created. This should be run before the deployment of the notebook. It can be either added to vdk-control-cli or to vdk-notebook(if we want this to be run for every notebook no matter whether it is a notebook job or not)or vdk-jupyterlab-extension.