Skip to content
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

Update APOD extension tutorial #8905

Merged
merged 5 commits into from Aug 26, 2020
Merged

Conversation

jasongrout
Copy link
Contributor

@jasongrout jasongrout commented Aug 26, 2020

References

Fixes #8859

Code changes

This updates the APOD tutorial and instructions for updating it.

User-facing changes

The APOD tutorial is updated

The new tutorial repo is updated, with the update at https://github.com/jupyterlab/jupyterlab_apod/tree/3.0

I also published the new jupyterlab_apod package to reserve the name: https://pypi.org/project/jupyterlab-apod/

Backwards-incompatible changes

@jasongrout jasongrout added this to the 3.0 milestone Aug 26, 2020
@jasongrout jasongrout added this to In progress in Extension System rework via automation Aug 26, 2020
@jupyterlab-dev-mode
Copy link

Thanks for making a pull request to JupyterLab!

To try out this branch on binder, follow this link: Binder

Copy link
Member

@blink1073 blink1073 left a comment

Choose a reason for hiding this comment

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

Thanks for taking this on!

docs/source/developer/extension_tutorial.rst Outdated Show resolved Hide resolved

JupyterLab extensions for JupyterLab 3.0 can be distributed as Python
packages. The cookiecutter template we used contains all of the Python
packaging instructions in the ``setup.py`` file. Before generating a package, we first need to install ``jupyter_packaging``.
Copy link
Member

Choose a reason for hiding this comment

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

Should we encourage publishing both so it can be used as a bundled extension?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think not, at least in this very first tutorial. The npm publishing instructions were quite intimidating, and it was great to just cut them all out. This tutorial should focus on the simplest recommended case, I think.

I think another tutorial where you have an extension that creates a new token used by other extensions (thereby necessitating an npm publish step), or perhaps just an appendix to this tutorial talking about why you would want to publish to npm, would be good.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, I like the idea of an Appendix, and listing it as an optional step

Copy link
Member

Choose a reason for hiding this comment

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

But I do think it should be encouraged, because token sharing is only one reason (optimization being the other).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can you take a look at the text I included now?

Copy link
Member

@blink1073 blink1073 left a comment

Choose a reason for hiding this comment

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

Thanks!

@blink1073 blink1073 merged commit d7c8adc into jupyterlab:master Aug 26, 2020
Extension System rework automation moved this from In progress to Done Aug 26, 2020
@github-actions github-actions bot added the status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Feb 23, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 23, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion.
Projects
Development

Successfully merging this pull request may close these issues.

Update APOD tutorial to use dynamic extensions
2 participants