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

added descriptions of the EIA861 data #3808

Merged

Conversation

Nancy9ice
Copy link
Contributor

Overview
Closes this Google Season of Docs Task:
Update the information of data sources that have missing information under their headings.
Note:
Only the EIA861 data had missing information in its headings so this was updated.

What problem does this address?
This helps users to know more information about the data sources ingested into the PUDL database

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

I ran the command make docs-build and checked if my changes reflected correctly locally

@aesharpe @zaneselvans

@aesharpe aesharpe self-requested a review August 22, 2024 20:23
@aesharpe aesharpe added the docs Documentation for users and contributors. label Sep 3, 2024
Copy link
Member

@aesharpe aesharpe left a comment

Choose a reason for hiding this comment

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

Lots of ideas! Thanks for filling in these blank sections!

I have some thoughts on the "Background" section as well. I think it would be nice to add something similar to the current 860 docs with the Schedules fleshed out:

As of 2024, the EIA-861 Form is organized into the following schedules:

You can find the schedules in the most recent form instructions (https://www.eia.gov/survey/form/eia_861/instructions.pdf)

Another thought that is out of scope but I want to mention is the harvesting process. We don't really mention this in our documentation, but we should! It's an integral part of how we process EIA860 and 923 data (notably, not 861). And feels like something that should come up on the Data Source pages or somewhere else.

docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
@Nancy9ice
Copy link
Contributor Author

Lots of ideas! Thanks for filling in these blank sections!

I have some thoughts on the "Background" section as well. I think it would be nice to add something similar to the current 860 docs with the Schedules fleshed out:

As of 2024, the EIA-861 Form is organized into the following schedules:

You can find the schedules in the most recent form instructions (https://www.eia.gov/survey/form/eia_861/instructions.pdf)

Another thought that is out of scope but I want to mention is the harvesting process. We don't really mention this in our documentation, but we should! It's an integral part of how we process EIA860 and 923 data (notably, not 861). And feels like something that should come up on the Data Source pages or somewhere else.

Please could you enlighten me on how this harvesting process works so I'll know what to add to the docs

@aesharpe
Copy link
Member

aesharpe commented Sep 5, 2024

Please could you enlighten me on how this harvesting process works so I'll know what to add to the docs

Yes! I will make a new issue about this with some detail. We don't have a address this as part of this PR.

docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
docs/templates/eia861_child.rst.jinja Outdated Show resolved Hide resolved
@aesharpe aesharpe added this pull request to the merge queue Sep 27, 2024
Merged via the queue into catalyst-cooperative:main with commit 312d9f0 Sep 28, 2024
12 checks passed
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.

3 participants