Skip to content
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

Move license to footer #17

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ahuang11
Copy link
Collaborator

@ahuang11 ahuang11 commented Jun 8, 2023

Closes ProjectPythia/pythia-foundations#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
Copy link

github-actions bot commented Jun 8, 2023

👋 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: 4ceae94
✅ Deployment Preview URL: In Progress

@droumis
Copy link
Member

droumis commented Jun 9, 2023

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
Copy link
Collaborator Author

ahuang11 commented Jun 9, 2023

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 PrefectHQ/prefect-great-expectations#30)

@droumis
Copy link
Member

droumis commented Jun 9, 2023

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
Copy link
Collaborator Author

ahuang11 commented Jun 9, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Moving the licensing and theme out of sight
2 participants