NASA-IMPACT / NASA-IMPACT/veda-docs
Add FAQ for JupyterHub usage
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 10
- Forks
- 16
- Avg merge
- 2d 31m
- Merged PRs (30d)
- 4
Description
One recurring issue is JupyterLab reporting notebooks as corrupted JSON. We should add guidance that when this happens the general recommendation is to re-check the notebook out from git if you haven't changed anything important and use the notebook checkpoints or a json validator if you need to recover more recent changes. This would likely be best organized into an FAQ which could be modularized for reference by other Hubs (e.g., MAAP - #57, OpenScapes, CryoCloud)
cc @wildintellect
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation's existing FAQ structure and reviewing how guidance is organized for other Hubs. Document the corrupted-JSON scenario, including re-checking notebooks from git, using checkpoints, and using a JSON validator for recovery. Done means the guidance is available in a reusable FAQ for VEDA and related Hubs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100