jupyterlab_apod icon indicating copy to clipboard operation
jupyterlab_apod copied to clipboard

Integrate this tutorial with https://github.com/jupyterlab/extension-examples

Open fcollonval opened this issue 4 years ago • 4 comments

Would it make sense to move this tutorial to the extension examples repository?

I see a few advantages:

  • Common maintenance on all extension examples
  • Point all interested users to the extension examples to go beyond this tutorial
  • As the examples are managed using lerna, this tutorial can still be published in its own package.

Disadvantage:

  • Hard to keep commits that follows tutorial steps

fcollonval avatar Mar 30 '20 12:03 fcollonval

@blink1073 @jasongrout @echarles @jtpio

What do you think?

fcollonval avatar Mar 30 '20 12:03 fcollonval

Having a repo with a single example rather than many examples can be less intimidating for the newcomers.

If we merge, the README of the extension examples repository should be revamped to be more welcoming.

We also need to think about the current doc to link to the example repo(s).

This being said, I see more advantages if we move everything under the same example repo umbrella.

echarles avatar Mar 30 '20 12:03 echarles

The docs could have a new section called "Authoring JupyterLab Extensions", as an entrypoint for developers who want to create a new extension:

  • https://jupyterlab.readthedocs.io/en/stable/developer/extension_points.html
  • https://jupyterlab.readthedocs.io/en/stable/developer/extension_dev.html
  • For an in-depth tutorial / walkthrough, a link to the apod tutorial (which could be a subfolder in the examples repo): https://github.com/jupyterlab/extension-examples/tree/apod
  • For more examples, link to the example repo: https://github.com/jupyterlab/extension-examples
  • Link to other third-party extensions (git, toc, debugger...) for extra materials

jtpio avatar Mar 30 '20 13:03 jtpio

The tagging isn't so bad, I am :+1:

blink1073 avatar Mar 30 '20 23:03 blink1073