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

Removing broken/template cookbooks from gallery #82

Closed
r-ford opened this issue Jul 28, 2022 · 3 comments
Closed

Removing broken/template cookbooks from gallery #82

r-ford opened this issue Jul 28, 2022 · 3 comments
Labels
content Content related issue

Comments

@r-ford
Copy link
Member

r-ford commented Jul 28, 2022

Now that we have a few cookbooks that mostly work (CESM LENS on AWS, CMIP6, HRRR AWS, and Radar), should we remove the entries that are currently only the template material (Packaging, XGCM) or broken (Physical Oceanography)? Maybe also the Matplotlib Colorbars cookbook, depending on overlap with this recent merge in Foundations.

@r-ford r-ford added the content Content related issue label Jul 28, 2022
@clyne
Copy link
Contributor

clyne commented Jul 28, 2022

I would opine that we either do not show cookbooks in the gallery that are known to be broken until we can fix them, or make use of the health check ("nightly-build") flag to indicate that they are broken in some way (but may still be useful to view).

@brian-rose
Copy link
Member

I think we can differentiate between cookbooks that are "broken but partially useful" and ones that really have no content. I opine that the ones that have no actual content beyond the template material (even if they have some work-in-progress stuff in open PRs) should not appear in our gallery.

So yes, I opine that we should remove Packaging and XGCM cookbooks from the gallery for now and add them back in when they have some content merged in.

Related points in #41: we should have tagged releases of Cookbook source repos to coincide with the decision to "include them in the gallery"
and in ProjectPythia/cookbook-template#53: our health checks need a more nuanced way to report failures in notebook execution.

r-ford added a commit that referenced this issue Aug 10, 2022
r-ford added a commit that referenced this issue Aug 10, 2022
@r-ford
Copy link
Member Author

r-ford commented Aug 23, 2022

Done with #84

@r-ford r-ford closed this as completed Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Content related issue
Projects
None yet
Development

No branches or pull requests

3 participants