ProjectPythia / landsat-ml-cookbook

Machine learning on Landsat satellite data using open source tools
https://projectpythia.org/landsat-ml-cookbook/
Apache License 2.0
11 stars 4 forks source link

Move license to footer #17

Open ahuang11 opened 1 year ago

ahuang11 commented 1 year ago

Closes https://github.com/ProjectPythia/pythia-foundations/issues/397

Motivation: Tutorial documentation often introduces new concepts or processes, and users may already be grappling with understanding unfamiliar information. A clean UI reduces cognitive load by simplifying the visual presentation and reducing unnecessary complexity. By minimizing distractions and focusing on essential elements, a clean UI helps users better absorb the tutorial content and decreases mental strain.

image image
github-actions[bot] commented 1 year ago

👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below. 🔍 Git commit SHA: 4ceae943120bbc08b43e168d96dd2e97397a6a98 ✅ Deployment Preview URL: In Progress

droumis commented 1 year ago

Hey @ahuang11, thanks for this!

I agree that this cleans the UI a bit for this cookbook and I'd be happy to merge. But first, we should factor in consistency across cookbooks as reducing complexity.

Therefore, I think we should either file an upstream PR, or at least ask the Pythia folks to weigh in on minor cookbook-specific theme changes like this. Your call

ahuang11 commented 1 year ago

Yes, I was thinking about these:

  1. I wanted to first see if others accept this change before doing mass updates
  2. I was wondering whether updates to the upstream template will propagate downstream

At the moment, I'm not convinced point 2 will be true because I don't see anything in https://github.com/ProjectPythia/cookbook-template/blob/main/environment.yml but I could be wrong.

If it's not implemented, I wonder if it's worthwhile to implement something to propagate these changes before more cookbooks are added. At Prefect, we used cruft to maintain consistency across multiple Collections, e.g. https://github.com/PrefectHQ/prefect-great-expectations/blob/main/.cruft.json and https://github.com/PrefectHQ/prefect-great-expectations/pull/30)

droumis commented 1 year ago

I think that's a great question/suggestion. I'd suggest starting that conversation on the cookbook template repo or on the Pythia discourse

ahuang11 commented 1 year ago

Added a post here: https://discourse.pangeo.io/t/propagating-changes-in-cookbook-templates/3506