Git Product home page Git Product logo

cookbook-gallery's Introduction

cookbook-gallery's People

Contributors

brian-rose avatar clyne avatar dcamron avatar dependabot[bot] avatar erogluorhan avatar jukent avatar ktyle avatar maxrjones avatar mgrover1 avatar pythia-pr-machine[bot] avatar r-ford avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cookbook-gallery's Issues

Updated index.md file not rendered

This PR, which should update the intro paragraph here was approved and merged, but the displayed text has not been updated. The displayed text is:

Pythia Cookbooks provide example workflows on more advanced and domain-specific problems developed by the Pythia community. Cookbooks build on top of skills you learn in Pythia Foundations.

It should read:

Pythia Cookbooks provide example workflows on more advanced and domain-specific problems developed by the Pythia community. Cookbooks build on top of skills you learn in Pythia Foundations.

Cookbooks are created from Jupyter Notebooks that we strive to binderize so each Cookbook can be executed in the cloud with a single click from your browswer. See documentation here for details. In some instances executing a Cookbook will require downloading the Notebook to your local laptop or desktop as described here.

Update Gallery with Kerchunk Cookbook

Root Repository Name

kerchunk-cookbook

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

yes

Additional comments

No response

guidance on using cookbooks

Some of the cookbooks will be binderized, but some may not be (or not publicly accessible via binder). Should we add guidance, adding to the text here perhaps, that:

  1. tells users how to launch via binder
  2. cautions the reader that binder may or may not be an option
  3. instructs them how to download the notebook file in the case that binder isn't an option?

Maybe we should just point them to this info on Foundations?

Use repository `_config.py` to grab items for the gallery cards

We can grab title, author, tag, and thumbnails all from the Jupyterbook conf.py files in each repository. I am going to change the code to do this because it is much more flexible and robust.

You may see some PRs on your cookbooks to add these elements to your cookbook, but feel free to customize them more.

CNAME file points to

CNAME points to tutorials.projectpythia.org. Is this file doing anything? Should it point to cookbooks.projectpythia.org? Pinging @kmpaul because you edited this file.

Update Gallery with new Cookbook

Root Repository Name

cookbook-template

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

yes

Update Gallery with new Cookbook

Root Repository Name

cookbook-template

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

yes

Additional comments

Test

Update Gallery with new Cookbook

Root Repository Name

intake-cookbook

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

yes

Additional comments

No response

Update Gallery with new Cookbook

Root Repository Name

intake-cookbook

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

yes

Additional comments

No response

Update Gallery with new Cookbook

Root Repository Name

intake-cookbook

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

No response

Additional comments

No response

Update Gallery with new Cookbook

Root Repository Name

intake-cookbook

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

yes

Additional comments

No response

Better support citation of cookbooks

Per the discussion started by @brian-rose there are a few things we might do to facilitate citation and giving credit to authors of cookbooks. Some things we might consider:

  1. Add an author(s) field to the template
  2. Display authors in the gallery "cards"
  3. Facilitate (provide guidance) on optionally creating a DOI for the notebook and display the DOI in cards and template.

Update Gallery with new Cookbook

Root Repository Name

cookbook-template

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

No response

Additional comments

No response

Link checker for gallery site

#107 brought to my attention the fact that we're not running any link checkers on this repo. And maybe not on the main portal repo either?

We should be able to use the sphinx link checker to accomplish this.

Update Gallery with new Cookbook

Root Repository Name

intake-cookbook

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

yes

Additional comments

No response

Should index.md be in .gitignore?

Every time I locally build the site it updates index.md but this is rewritten when the site is built, no? Should this file be in .gitignore to reduce confusion as to where to make edits to the site (see #38 )

Update Gallery with new Cookbook

Root Repository Name

gridding-cookbook

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

yes

Additional comments

Hello! This has been sent before, but @dcamron asked for me to re-send this. Please let me know if this is a duplicate effort :).

Best,
Thomas

edit by @dcamron

Update Gallery with new Cookbook

Root Repository Name

cesm-lens-aws-cookbook

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

yes

Update Gallery with new Cookbook

Root Repository Name

cookbook-template

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

no

Automation for Cookbook repos

We frequently have a need to push identical (or very similar) changes out simultaneously to all Cookbook source repos. One example is changing the URL for the binder link in the _config.yml in each repo as discussed in #85

Currently we have no better option than manually edit and opening identical PRs in each repo.

Two possible alternatives for keeping the infrastructure updated across all repos:

  1. Some kind of bot service (like dependabot) that can automatically open PRs across all repos (e.g. when we make a change in the template repo). This still requires people to inspect and approve the PRs for each repo, but would speed things up and help ensure consistency while still allowing individual Cookbook authors to customize their own infrastructure as necessary
  2. Migrating more of the Cookbook infrastructure out of individual repos and into some centralized repository. For example, instead of hard-coding the Binder URL in each repo's _config.yml, there could be a lookup step. This would mean only opening a single PR to change any of the centralized infrastructure across all Cookbooks.

Fixing broken Binder links

Currently most of our Cookbooks are failing their nightly health checks due a bad link, e.g.
https://github.com/ProjectPythiaCookbooks/HRRR-AWS-cookbook/runs/7778415916?check_suite_focus=true

The cause is that the Pangeo Binder service at https://binder-staging.2i2c.cloud is permanently offline.

As discussed at today's IWG, we are hoping to direct Cookbooks to a dedicated BinderHub running on JetStream2, but it is not ready for prime time just yet.

In the mean time we will redirect all Cookbook binder links to mybinder.org

Update Gallery with new Cookbook

Root Repository Name

cookbook-template

Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?

No response

Additional comments

Test

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.