Create new issue template for adding a new year of data

[aesharpe]

Added a template for adding new years of EIA annual release data

[aesharpe]

@jdangerx do you know how to test whether this template works?

[cmgosnell]

this is going to be a great resource! its a great idea.

I left a few specific requests/questions, but I think my high-level suggestion here is as much as possible link to pages and instructions that already exist in our documentation for as many of these bullets as possible and just add the detail in the docs pages when there isn't currently sufficient detail.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (40308d1) 92.6% compared to head (77c8e79) 92.6%.
Report is 2 commits behind head on dev.

Additional details and impacted files

@@          Coverage Diff          @@
##             dev   #3089   +/-   ##
=====================================
  Coverage   92.6%   92.6%           
=====================================
  Files        134     134           
  Lines      12535   12535           
=====================================
  Hits       11607   11607           
  Misses       928     928           

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

[cmgosnell]

You need to add the updating the settings files in here.

And I still think it would be preferable to have most if not all of these steps very brief high-level words with links to our annual updates docs (or other relevant docs). Like "- [ ] Update the settings files" so these instructions don't duplicate and potentially veer off course from the annual updates docs.

[aesharpe]

You need to add the updating the settings files in here.

Oh yeah, I think these instructions came from an early-to-final release checklist which is why they aren't there.

[aesharpe]

And I still think it would be preferable to have most if not all of these steps very brief high-level words with links to our annual updates docs (or other relevant docs). Like "- [ ] Update the settings files" so these instructions don't duplicate and potentially veer off course from the annual updates docs.

Ugh, I agree here 100% RE: duplication, but I also feel like I created this checklist in the first place because I was annoyed about having to go back and forth between so many sources.

[cmgosnell]

Ugh, I agree here 100% RE: duplication, but I also feel like I created this checklist in the first place because I was annoyed about having to go back and forth between so many sources.

I don't disagree with you the back and forth-ness in general but I seems like creating another place to look for this new or potentially different information is just adding to the problem. I see the value of an issue checklist here as a way to consolidate all of the steps in one place for EIA specifically. plus the very visible checklist for ourselves or a contributor! which is great, but we have all of these steps enumerated in great detail in the docs.

[jdangerx]

@jdangerx do you know how to test whether this template works?

In my experience this is done via Trial and Error 😓 . A quick search turns up a web editor which lets you preview, etc. - you could maybe just put your intended content in this PR but make the issue via that UI?

[aesharpe]

@cmgosnell I made a big overhaul change that basically just mimics the format of the annual updates page in the docs. You are right and I should stop fighting the docs I literally wrote myself.... I think this is much better / now it applies to all of the datasets not just EIA.

[aesharpe]

In my experience this is done via Trial and Error 😓 . A quick search turns up a web editor which lets you preview, etc. - you could maybe just put your intended content in this PR but make the issue via that UI?

I tested the content of the template file in the UI preview and it seemed to render properly!

[cmgosnell]

links to the docs that you literally wrote! hehe but with check boxes in a tasklist setup for easy clicky clicky.

(actually you could add the ```[tasklist] thing if you want)

(also idk if the environments files are supposed to be updated here? i think that'll all go away when you merge in dev)

[aesharpe]

(actually you could add the ```[tasklist] thing if you want)

Sadly, it doesn't seem to render properly when you add in "[tasklist]." This is a rather funny thread from Github explaining that it's not normal markdown: github/markup#208