[ENH] Improve the consistency of folder/files structure in notebooks repositories
acocac opened this issue · comments
Describe the proposed improvement to the documentation
The notebook repositories don't have a consistent folder/file structure.
The optimal folder and files structure is:
.binder (contain the environment.yml file)
.github (contain the workflow for automating notebooks)
.lock (contain lock files)
.gitignore
LICENSE
README.md
config.json
.ipynb
In addition, the README.md should contain further instructions how to run the notebook in Binder or locally. See for example general-preprocessing-rainfall_noaa.
Additional information
The suggested changes require access to the EnvDSbook organisation. In most of the notebooks, the lock files are inside .binder folder so they should be moved to the .locks folder.
Closing the issue as all published notebooks have the same consistency, updated in the jupyter book in commit 24c57fa