-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clean up directory structure & convert notebooks to .md files #59
Comments
Hi @dhavide and @jnywong! This is what I got so far, I am not sure about the location of many of the files, such as the nb to select AOI, and remote sensing, which I included in geospatial fundamentals. Also, many notebooks seem to be placeholders. │ .gitignore Let me know what I need to change. Regarding the files, I converted all files to .md, did the round-trip conversion, use diff to check if the conversion was done properly. |
Thanks Patri, I'll correct that! |
Hey @JFormoso I'm happy with this directory structure! The assets directory will need to move into the book folder for the Jupyter Book to find the image files however. Can I double-check that the |
Hi @jnywong I really don't know if the intro.md file is the future homepage. All ask at Friday's meeting. I made the changes you suggested, I am not sure if the pull request shows them or how to merge that. Let me know! |
Roughly speaking, this is what is needed:
Convert all existing notebook (i.e.,
.ipynb
) files to Markdown(.md
) files, e.g.,The current
environment.yaml
file includesjupytext
so try updating your environment ifjupytext
is not installed locally.To be safe, make sure that the files are converted correctly by doing a round-trip conversion and using
diff
to ensure that the original.ipynb
file is restored correctly. There will be some differences (e.g., in cell labels) but those can safely be ignored.Introduce a directory structure that looks something like this:
(use numbered directories in sequence according to the diagram so that the intended order is clear, e.g.,
01_Open_Science/
,02_Geospatial_fundamentals/
, etc. Use the sequence as in the diagram for now; that may change later).Move MarkDown files (and whatever else) into the appropriate directories. This may break relative links to, e.g., image files in the
assets
folder. Check to make sure these links are correct before checking in.Use a directory called, e.g.,
scratch
to store files that currently do not have an obvious place; they most likely have a future use.The text was updated successfully, but these errors were encountered: