Draft notebook templates

[ateucher]

This is a first attempt to add notebook templates, based on the draft style guide and cookbook coworking.

This serves several purposes:

1. Provide standardized metadata to every notebook that can (hopefully) be parsed and used for integration into the NASA Earthdata website
2. Standardize presentation of title, authors, etc.
3. Standardize tutorial sections
4. Provide an easy entry point for new contributions

These are lightly modified from the Project Pythia template, with Quarto metadata added at the top. I've added a .qmd and .ipynb template. For the .qmd template, the metadata is in the yaml frontmatter, and for .ipynb it is in a raw cell at the beginning of the document.

I think for diff-viewing and line-by-line review in this PR, the .qmd document is the easiest, but they are essentially the same content. So I think we should iterate on the .qmd and then copy to the .ipynb when ready.

Note that the nasa-metadata key is just to hold metadata. It is a non-standard key (which Quarto allows) so we can provide that information in a structured way. Everything else is a standard key that Quarto uses in some way to control rendering or populate content.

TODO:

• Decide on metadata fields
• Add instructions in the contributing guide for how to use the templates ([Notebook templates]: Add instructions in the contributing guide for how to use the templates #442)
• Add R versions
• Decide on sections and add templates for different categories (to-dos, tutorials) ([Notebook templates]: Add instructions in the contributing guide for how to use the templates #442)
• Borrow from ASDC's cookbook PR hooks for checking on PRs (from @danielfromearth) (Add automated checks for incoming notebooks #443)

Rendered versions of the templates are in the deploy preview: ipynb and qmd

[github-actions]

🚀 Deployed on https://deploy-preview-414--openscapes-org-preview.netlify.app

[jules32]

Thanks Andy! Thanks for incorporating all the ideas from yesterday. I added a few comments here but think it's ready to talk through on Wednesday :)

[jules32]

Should an environment (ie corn, py-rocket?) be part of the metadata?

Thinking if folks will download single notebooks with a button, would they need a link to an environment?

[ateucher]

Should an environment (ie corn, py-rocket?) be part of the metadata?

Thinking if folks will download single notebooks with a button, would they need a link to an environment?

This is a good idea, I think since these metadata aren't exposed to the user (They don't show up in rendered content), do you think we should have a written section in the template, outside the metadata?

[ateucher]

I think this is close to being ready to merge at least so we can test it out? @asteiker @andypbarrett do you have thoughts on using the GCMD keywords? I can't access the wiki

[ateucher]

After coworking today, I wonder if we should narrow the scope of this PR to be just the main template body and the Quarto metadata, and move the NASA metadata/CMR integration discussion to a different issue/PR?

Then we could get this merged with the basic template and start using it.

What do you think @danielfromearth @michele-ornl @asteiker @andypbarrett @mikala-nsidc @alexishunzinger

[danielfromearth]

Yeah, sounds good to me. I do think it will be helpful to have the NASA-specific metadata discussed by itself.

[ateucher]

@danielfromearth thanks for the review! As discussed I've pulled out the NASA-specific metadata and just have the cookbook-focused core metadata. I've opened issues about the rest to add as we get more clarity about how they will be used