The JupyterLite index page does not explain the sidebar or that its files are volatile

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#168 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
88/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
bootstrap, jupyter-notebook
Domaine
documentation

Piste de recherche

La modification se fait dans docs/notebooks/index.ipynb, la page d'accueil de JupyterLite. Ouvre le notebook et vérifie sa dernière cellule. Lis ensuite l'extrait de l'issue, prêt à être collé comme nouvelle cellule markdown. C'est terminé lorsque la nouvelle cellule s'affiche à la fin du notebook dans JupyterLite, que l'encadré d'alerte div est stylisé et que chaque texte de lien de la barre latérale est correct.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Likely smell, found while working on the notebooks in RTB. Worth checking out and adding.

docs/notebooks/index.ipynb is the landing page of the JupyterLite site, but it says nothing about the sidebar. A new user does not learn that the files listed there live only in the browser (IndexedDB), how to upload or open one, or that clearing the browser cache or ending the session loses them. RTB now has a short section for this (petercorke/robotics-toolbox-python#917), as a Bootstrap alert box, which JupyterLab and JupyterLite style with theme colors:

## Working with files

<div class="alert alert-info">

**The sidebar.** The left-hand **sidebar** lists the local files, which are kept in a virtual file system within the browser (managed via IndexedDB).

* To create a new notebook use *File/New/Notebook*
* To upload a notebook or data file use the upload icon above the sidebar, or drag and drop files onto the sidebar
* To load and open a file from a URL, use *File/Open From URL...*

These files are volatile and vulnerable to browser cache clearing or session termination. You can download these files to your local drive by right-clicking a file in the sidebar and selecting *Download*.

</div>

It goes as a new last cell of index.ipynb.

Langage dominant
Python
Étoiles
225
Forks
35
Merge moyen
1 j 12 h
PR mergées (30 j)
33

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de petercorke/machinevision-toolbox-python

Toutes les issues de petercorke/machinevision-toolbox-python

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.