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

Add manual build and deploy to help learning experience #117

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

oscar6echo
Copy link

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
Copy link
Author

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

@epugh
Copy link

epugh commented May 16, 2023

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
Copy link
Member

jtpio commented May 17, 2023

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

REM make sure git is clear:
REM git status --porcelain

git push origin --delete gh-pages
Copy link
Member

Choose a reason for hiding this comment

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

The gh-pages approach has the drawback of increasing the repo size quite significantly.

Also the GitHub Action to deploy to GitHub Pages will likely be default way soon.

Copy link
Member

Choose a reason for hiding this comment

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

So not sure about recommending using gh-pages (even though it's been there for years)

Copy link
Author

Choose a reason for hiding this comment

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

Is not "Github Pages" and "gh-pages" the same thing ?
Any deployment must necessarily provide the static site somewhere, right ?
And the latest stage is enough - no need for history.
If so, this is what the deploy script does.

Now deploying on github is not a reco in my mind, just a fast way to test, available to anybody.

Copy link
Author

Choose a reason for hiding this comment

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

Even faster is local deploy - added in the section - this brings attention to the dist repo.

@oscar6echo
Copy link
Author

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants