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

Aberta Para iniciantes
  • Algo errado?
#168 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
1/5
Tempo estimado
Menos de uma hora
Facilidade para iniciantes
88/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
bootstrap, jupyter-notebook
Domínio
documentation

Direção de pesquisa

A mudança vai em docs/notebooks/index.ipynb, a página inicial do JupyterLite. Abra o notebook e confira a última célula. Depois, leia o trecho da issue, que está pronto para ser colado como uma nova célula markdown. Está concluído quando a nova célula é renderizada no fim do notebook no JupyterLite, a caixa de alerta div estiver estilizada e todos os textos dos links da barra lateral estiverem corretos.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Python
Estrelas
225
Forks
35
Merge médio
1d 12h
PRs com merge (30d)
33

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de petercorke/machinevision-toolbox-python

Todas as issues de petercorke/machinevision-toolbox-python

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.