Skip to content

Move opening help resources to a separate plugin #14837

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.

Sign up for GitHub

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

Jump to bottom
Merged
fcollonval merged 4 commits into from
Jul 31, 2023
Merged

Move opening help resources to a separate plugin #14837

fcollonval merged 4 commits into from
Jul 31, 2023

Conversation

@jtpio
Copy link
Member

@jtpio jtpio commented Jul 17, 2023

References

This should help with jupyter/notebook#6963 and jupyter/notebook#6968

Code changes

Move the command that opens help resources in the main area in IFrames or new browser tabs to a new plugin.

That way, downstream applications like Notebook 7 can choose to not include this plugin and provide their own instead.

User-facing changes

None

Backwards-incompatible changes

None

@jupyterlab-probot
Copy link

jupyterlab-probot bot commented Jul 17, 2023

Thanks for making a pull request to jupyterlab!
To try out this branch on binder, follow this link: Binder

This was referenced Jul 17, 2023
Merged
Closed
@jtpio jtpio added this to the 4.0.x milestone Jul 17, 2023
fcollonval
fcollonval requested changes Jul 20, 2023
View reviewed changes
Copy link
Member

@fcollonval fcollonval left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jtpio

I spotted a small error. But otherwise it looks good to go.

However I'm not in favor of backporting it to 4.0.x as the new plugin defines a command from the old resources plugin. So if someone disable the resources, it may create a conflict by providing its own implementation of that command or simply adding a command he does not want.

@jtpio @fcollonval
Update packages/help-extension/src/index.tsx
775a31c 
Co-authored-by: Frédéric Collonval <fcollonval@users.noreply.github.com>
@jtpio
Copy link
Member Author

jtpio commented Jul 20, 2023

However I'm not in favor of backporting it to 4.0.x as the new plugin defines a command from the old resources plugin. So if someone disable the resources, it may create a conflict by providing its own implementation of that command or simply adding a command he does not want.

Yeah that's always the issue when moving functionalities between plugins. It's not really a breaking change technically, but it can indeed change the behavior of a deployed JupyterLab instance.

OK to bump to 4.1 then. Maybe we should keep track of such changes somewhere in the docs. Not sure it should be part of the extension migration guide since it's more an admin / user option. Maybe a quick mention in the changelog would be enough.

@jtpio jtpio modified the milestones: 4.0.x, 4.1.0 Jul 20, 2023
fcollonval
fcollonval approved these changes Jul 23, 2023
View reviewed changes
Copy link
Member

@fcollonval fcollonval left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jtpio

Do you think you could add a note in the CHANGELOG as part of this PR so we don't forget to do it when releasing?

@jtpio
Copy link
Member Author

jtpio commented Jul 24, 2023

Maybe we can add the note under the v4.0 section for now since 4.1.0 does not exist yet (will be added by the Jupyter Releaser): https://jupyterlab.readthedocs.io/en/latest/getting_started/changelog.html#v4-0

jtpio
jtpio commented Jul 28, 2023
View reviewed changes
CHANGELOG.md

# JupyterLab Changelog

## v4.1
Copy link
Member Author

@jtpio jtpio Jul 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's see if CI still passes with this new section.

@fcollonval
Copy link
Member

fcollonval commented Jul 31, 2023

Thanks @jtpio

Remaining CI failures are not related

@fcollonval fcollonval merged commit a60459b into jupyterlab:main Jul 31, 2023
@jtpio jtpio deleted the open-resource-plugin branch July 31, 2023 13:54
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@fcollonval fcollonval fcollonval approved these changes

Assignees

@jtpio jtpio

Labels

documentation maintenance pkg:help

Projects

None yet

Milestone

4.1.0

Development

Successfully merging this pull request may close these issues.

2 participants

@jtpio @fcollonval