-
Notifications
You must be signed in to change notification settings - Fork 5k
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
Edit notebook metadata #6402
Comments
Marking as a good first issue in case someone would like to take it, thanks! |
The new plugin could go the That file already has some places showing how to retrieve the current notebook. which can serve as an example. |
Hi! Can I try this one? |
Just checking if anybody is still working on this |
@kostyafarber I don't think anyone is still working on this so if you want to have a look that would be great, thanks! In the meantime there has been some work on adding support for (hidden by default) left and right panels: The notebook metadata can be edited there, but there could also be the popup like the classic notebook so it's easier to find. |
Hey @jtpio I would like to try and solve this issue, can you please assign it to me? |
Thanks @ShobhanSrivastava. I guess it could still make sense to implement the dialog to edit the notebook metadata to keep the same UX as with the classic notebook. cc @brichet in case you have an input on this, since this might also be related to some upstream work in JupyterLab. |
I think we should use the existing For example, I started to extend the |
Maybe the simplest way for now would be to add a |
test |
Hi @jtpio I would like to try and solve the issue if it still persists. |
Sure thanks @abidkhan484. Feel free to open a Pr any time. Probably the suggestion from #6402 (comment) would be enough for now. |
Hi @jtpio I am new in open source contribution. I have read the contributing.md file.
|
You would first need to fork the repository on GitHub: Then you can create a new branch on your fork. Once ready, you can open a PR against the
Yes, it should be a frontend only change. If we stick to just adding the menu entry as suggested above, then it mostly means adding a new setting file here to add the entry to the menu: https://github.com/jupyter/notebook/tree/main/packages/notebook-extension/schema
If you would like to, you could also use Gitpod as an alternative to setting up a development environment locally. |
Hi, |
Thanks @Dilip-Jain for looking into this 👍 You can see the Notebook 7 application as a JupyterLab remix. This means the frontend reuses many JupyterLab plugins and extensions, and reassemble them in a different way to create this document-oriented notebook UI. So most of the commands are inherited from JupyterLab. You can do a text search on the JupyterLab repo to find some hints: https://github.com/jupyterlab/jupyterlab. The documentation also lists the available in JupyterLab: https://jupyterlab.readthedocs.io/en/latest/user/commands.html#commands-list. Although in the case of Notebook 7 only a subset of the commands are available. One way to start on this issue would be to have a look at how existing commands can be added as menu items to the Notebook 7 interface. For example the application extension uses the settings system to re-order the menu entries: notebook/packages/application-extension/schema/menus.json Lines 4 to 75 in b397a3b
|
As a side note it would indeed be useful to expand the existing contributing guide to explain how Notebook 7 reuses JupyterLab plugins and extensions: https://jupyter-notebook.readthedocs.io/en/latest/contributing.html |
Hello everyone, I'm working on this issue on and off for a while for a college class. I've managed to change some stuff around in the menus.json file and thought I was almost done, just needed to add an option with a command to show the Notebook Tools panel as suggested. The thing is, when I run ctrl+shift+c and the command palette pops us, there's the "Show Notebook Tools" command easily, but I cannot find it in the commands page. Can I have any guidance? Thanks |
Edit Notebook Metadata plugin added under Edit Menu for functionality similar to classic-notebook. Clicking on the option under the menu opens up the Notebook Tools widget in the right sidebar and expands the Additional Tools (which contains the Notebook Metadata editor) collapsible section (default: collapsed).
Hi @joaovml, what you are looking for is an application command Unfortunately, I didn't know you were working on the issue, and since the issue was inactive for quite a long duration, I picked it up last week and started working on it. I just created a pull request and realized you too were working on this. |
Hi @Dilip-Jain ! No problem, I hadn't mentioned anything here. Your solution will be great in helping me understand a bit better how the code works and hopefully I'll be able to contribute somewhere else. |
Good luck @joaovml |
Hey @jtpio, |
Hi is there anyone still working on this? |
Hey @W0474997SteveArmstrong, I have already created a pull request for this enhancement. The only task left is adding the menu entry via the settings defined in the schema folder dropping the dependency on IMainMenu in the plugin. |
* Added Edit Notebook Metadata Option (#6402) Edit Notebook Metadata plugin added under Edit Menu for functionality similar to classic-notebook. Clicking on the option under the menu opens up the Notebook Tools widget in the right sidebar and expands the Additional Tools (which contains the Notebook Metadata editor) collapsible section (default: collapsed). * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Added Edit Notebook Metadata Option (#6402) * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Prettier Code for passing Test Lint check * Prettier Code for passing Test Lint check * adding the edit-notebook-metadata entry via schema adding the menu entry via the settings defined in the schema folder dropping the dependency on IMainMenu in the plugin * adding the edit-notebook-metadata entry via schema adding the menu entry via the settings defined in the schema folder dropping the dependency on IMainMenu in the plugin * adding the edit-notebook-metadata entry via schema * adding the edit-notebook-metadata entry via schema * adding the edit-notebook-metadata entry via schema * fix menu item * Add to the command palette * Update Playwright Snapshots * Update Playwright Snapshots * fix snapshots --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Jeremy Tuloup <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Problem
In the classic notebook it's possible to edit the notebook metadata:
Proposed Solution
We add a new plugin to replicate that UX and let users edit notebook metadata in a dialog.
Additional context
In JupyterLab the notebook tools is in the right area:
The text was updated successfully, but these errors were encountered: