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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#168 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
88/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
bootstrap, jupyter-notebook
Área
documentation

Línea de trabajo

El cambio va en docs/notebooks/index.ipynb, la página de inicio de JupyterLite. Abre el notebook y revisa su última celda. Después, lee el fragmento del issue, que está listo para pegarse como una nueva celda de markdown. Está terminado cuando la nueva celda se renderiza al final del notebook en JupyterLite, el cuadro de alerta div tiene estilo y todos los textos de los enlaces de la barra lateral son correctos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
225
Forks
35
Merge medio
1 d 12 h
PR fusionados (30 d)
33

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de petercorke/machinevision-toolbox-python

Todos los issues de petercorke/machinevision-toolbox-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.