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

docs: add a reference to the Xeus kernel template #152

Merged
merged 2 commits into from
Jan 25, 2025

Conversation

agriyakhetarpal
Copy link
Member

Description

It was tricky for a user to see how to set up a Xeus/xeus-python-based deployment from this repository, and I think that this repository can link to the https://github.com/jupyterlite/xeus-python-demo for that. Since the README there also contains a short comparison of the Pyodide and Xeus kernels, I think adding this cross-reference would help newcomers who would like to switch between kernels, as this repository shows up as the second search result for "jupyterlite template" on search engines and one needs to search for "jupyterlite template xeus" explicitly to find the Xeus one.

Changes added

  • Mentioned which kernels are available through this template
  • Cross-linked to the Xeus template repository

P.S. Maybe this has already been discussed elsewhere, but a cookiecutter template (or better, one using copier) that would unify both repositories would also be nice. However, that would not work with the green "Use this template" button on GitHub, which is quicker.

@jtpio
Copy link
Member

jtpio commented Jan 25, 2025

P.S. Maybe this has already been discussed elsewhere, but a cookiecutter template (or better, one using copier) that would unify both repositories would also be nice. However, that would not work with the green "Use this template" button on GitHub, which is quicker.

Right, the main problem with cookiecutter or copier is that folks would have to open a terminal, install dependencies locally, run commands. All of this is error-prone, requires time and is less accessible than a plain copy via the GitHub template system.

Co-authored-by: Jeremy Tuloup <[email protected]>
Copy link
Member

@jtpio jtpio 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 jtpio merged commit 358224a into jupyterlite:main Jan 25, 2025
2 checks passed
@agriyakhetarpal agriyakhetarpal deleted the docs/xeus-kernel branch January 25, 2025 11:48
iliev-georgi pushed a commit to iliev-georgi/jupyter-lite-demo that referenced this pull request Feb 22, 2025
* List available kernels, add link to Xeus kernel

* Tenplate, not theme

Co-authored-by: Jeremy Tuloup <[email protected]>

---------

Co-authored-by: Jeremy Tuloup <[email protected]>
iliev-georgi pushed a commit to iliev-georgi/jupyter-lite-demo that referenced this pull request Feb 22, 2025
* List available kernels, add link to Xeus kernel

* Tenplate, not theme

Co-authored-by: Jeremy Tuloup <[email protected]>

---------

Co-authored-by: Jeremy Tuloup <[email protected]>
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.

2 participants