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

Remove obsolete Docker data access instructions. #3156

Merged
merged 5 commits into from
Dec 15, 2023
Merged

Conversation

zaneselvans
Copy link
Member

Overview

  • Removed obsolete references in the README to using Docker containers + Jupyter locally to access data.
  • Added pointers to Kaggle and Zenodo instead.

How did you make sure this worked? How can a reviewer verify this?

To-do list

Edit tasklist title
Beta Give feedback Tasklist To-do list, more options

Delete tasklist

Delete tasklist block?
Are you sure? All relationships in this tasklist will be removed.
  1. Ran the docs build locally.
    Options

@zaneselvans zaneselvans added the docs Documentation for users and contributors. label Dec 13, 2023
@zaneselvans zaneselvans self-assigned this Dec 13, 2023
@zaneselvans zaneselvans marked this pull request as ready for review December 14, 2023 00:24
Copy link

codecov bot commented Dec 14, 2023

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (98492e6) 92.7% compared to head (26de704) 92.7%.
Report is 12 commits behind head on dev.

Files Patch % Lines
src/pudl/etl/cli.py 33.3% 2 Missing ⚠️
Additional details and impacted files
@@          Coverage Diff          @@
##             dev   #3156   +/-   ##
=====================================
  Coverage   92.7%   92.7%           
=====================================
  Files        134     134           
  Lines      12597   12598    +1     
=====================================
+ Hits       11672   11676    +4     
+ Misses       925     922    -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zaneselvans zaneselvans requested review from cmgosnell and removed request for jdangerx December 14, 2023 15:24
Copy link
Member

@cmgosnell cmgosnell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to be honest, at a high level I greatly dislike that this whole How do I access the data? does not just include a bunch of links to the data access page. Bc these two sets of access modes often diverge and end up having conflicting information. Could we just convert this whole section to be a link the the data access docs page and a list of the links to the headers on that page? Which is perhaps out of scope for this pr.

my one probably should be in scope for this pr request is that we at least add kaggle into the data access page. which could literally be a copy paste of this language.

`the Catalyst Cooperative Community <https://zenodo.org/communities/catalyst-cooperative/>`__.
Zenodo assigns long-lived DOIs to each archive, suitable for citation in academic
journals and other publications. The most recent versioned PUDL data release can be
found using this Concept DOI: https://doi.org/10.5281/zenodo.3653158
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1000% nit but using the "Concept DOI" language is jargony and imo not adding anything.

@zaneselvans zaneselvans merged commit 0e36ef9 into dev Dec 15, 2023
14 of 15 checks passed
@zaneselvans zaneselvans deleted the no-docker-readme branch December 15, 2023 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation for users and contributors.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants