search

jupyterlite / demo

JupyterLite demo deployed to GitHub Pages 🚀
https://jupyterlite.github.io/demo
356 stars 192 forks source link

Add manual build and deploy to help learning experience #117

Open oscar6echo opened 1 year ago

oscar6echo commented 1 year ago

As a user, I would rather not jump directly to full automation - with GA.
Instead, I am much more interested to go step by step, and only when full understood, use magical automation.

Somebody who wants to create a custom jupytelite may start from there and iterate/change the repo to fine tune their specifics.
Then the deploy script is so fast that in many cases it is a good option to just run it - like you would run say a "git push --tags".

Hope this helps.

oscar6echo commented 1 year ago

btw maybe there could be a refenrece to the official doc to indicate this step by step deploy approach.

epugh commented 1 year ago

I like this... I've found that customizing jupyterlite for embedding in Quepid has been daunting at times... A lot of concepts to engage with!

jtpio commented 1 year ago

btw maybe there could be a refenrece to the official doc to indicate this step by step deploy approach.

I think that was the intent of this guide: https://jupyterlite.readthedocs.io/en/latest/quickstart/standalone.html

Otherwise maybe there could be a new guide under this section called "Deploy to GitHub Pages manually": https://jupyterlite.readthedocs.io/en/latest/howto/index.html#deploying

Note there is also this tutorial I was hoping to contribute some parts of it to the main docs: https://pyconde2023-jupyterlite.readthedocs.io/en/latest/tutorial.html

oscar6echo commented 1 year ago

I think that was the intent of this guide: https://jupyterlite.readthedocs.io/en/latest/quickstart/standalone.html

Otherwise maybe there could be a new guide under this section called "Deploy to GitHub Pages manually": https://jupyterlite.readthedocs.io/en/latest/howto/index.html#deploying

I agree this step by step "local first" guide may be available in several places and shapes. I have no strong opinion about it.

In my mind this PR is not necessarily meant to be merged, rather to show how a user - like me, but I cannot be that special - would go about trying jupyterlite beyond the initial demo effect provided by the full automatic process. There is nothing like running commands in terminal, watching the effects, adjust, all the way to deployment. This is all the more true for a static site which can easily be tweaked before deploy.

If you prefer taking pieces of it, or just the genral idea to write it differently, this is 100% fine with me.

(But writing it as a PR enabled me to test it)