NASA-Openscapes / earthdata-cloud-cookbook

A tutorial book of workflows for research using NASA EarthData in the Cloud created by the NASA-Openscapes team
https://nasa-openscapes.github.io/earthdata-cloud-cookbook
Other
87 stars 32 forks source link

Add labels to how-to's and tutorials with environment requirements #285

Open asteiker opened 8 months ago

asteiker commented 8 months ago

As part of the goal of helping cookbook users understand how to run the content in the notebook, one idea is to add labels to each of our how-to's and tutorials that clarify whether you need to be in us-west-2 to run or whether you can run the notebook successfully outside of the cloud. Labels could help clarify this and set users up better for success when attempting to run on their own. Perhaps we could use Quarto call out blocks or something else that's flashy and easy to scan / interpret? https://quarto.org/docs/authoring/callouts.html

asteiker commented 8 months ago

Related to #284 to help users understand how to run the code in our cookbook.

jules32 commented 8 months ago

I really like this idea!

ateucher commented 3 months ago

@cboettig had a good idea for this - use badging (like https://shields.io/).