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

Include sub-annual updates in annual_updates docs #3129

Merged
merged 10 commits into from
Dec 13, 2023

Conversation

aesharpe
Copy link
Member

@aesharpe aesharpe commented Dec 7, 2023

The current documentation page for adding new data is called "Annual Updates". This is misleading because the page caters to all sorts of annual and sub-annual updates to existing data.

I changed the name to "Existing Data Updates" and updated some of the language in the documents to be more inclusive of all types of data updates.

Closes #3130

@aesharpe
Copy link
Member Author

aesharpe commented Dec 7, 2023

Currently dev is failing the ci so I pushed all these commits with a no-verify flag. Once dev is back up and running we'll see if the tests pass here too.

Comment on lines +1 to +12
---
name: Integrate New Year of Data
about: Check-list for integrating a new year of data
title: ''
labels: new-data
assignees: ''

---

### New year of data integration check-list:

Based on the [Existing Data Updates Docs](https://catalystcoop-pudl.readthedocs.io/en/dev/dev/existing_data_updates.html)
Copy link
Member Author

@aesharpe aesharpe Dec 7, 2023

Choose a reason for hiding this comment

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

This whole module is showing up as deleted and then re-added I think because the percentage content change is large enough that git doesn't recognize it as the same file? I tried to prevent this by running separate commits - one for the file changes and one for the file rename - but that didn't seem to help.

https://stackoverflow.com/questions/7938582/how-does-git-detect-similar-files-for-its-rename-detection

Copy link
Member

Choose a reason for hiding this comment

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

that's annoying but of well :-/

@aesharpe aesharpe self-assigned this Dec 7, 2023
@aesharpe aesharpe linked an issue Dec 7, 2023 that may be closed by this pull request
@aesharpe aesharpe marked this pull request as ready for review December 8, 2023 17:02
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.

this looks great! i added two non-blocking suggestions but they are vv minor

Comment on lines +1 to +12
---
name: Integrate New Year of Data
about: Check-list for integrating a new year of data
title: ''
labels: new-data
assignees: ''

---

### New year of data integration check-list:

Based on the [Existing Data Updates Docs](https://catalystcoop-pudl.readthedocs.io/en/dev/dev/existing_data_updates.html)
Copy link
Member

Choose a reason for hiding this comment

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

that's annoying but of well :-/

docs/dev/existing_data_updates.rst Outdated Show resolved Hide resolved
docs/dev/existing_data_updates.rst Outdated Show resolved Hide resolved
docs/dev/existing_data_updates.rst Outdated Show resolved Hide resolved
Copy link

codecov bot commented Dec 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (40c799c) 92.6% compared to head (1a1ea61) 92.6%.
Report is 4 commits behind head on dev.

Additional details and impacted files
@@          Coverage Diff          @@
##             dev   #3129   +/-   ##
=====================================
  Coverage   92.6%   92.6%           
=====================================
  Files        134     134           
  Lines      12577   12577           
=====================================
+ Hits       11648   11649    +1     
+ Misses       929     928    -1     

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

@aesharpe aesharpe merged commit 2bd73ac into dev Dec 13, 2023
13 checks passed
@aesharpe aesharpe deleted the include-quarterly-updates-in-docs branch December 13, 2023 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Update documentation about how to integrate new data updates
2 participants