Feature 497 headers

[lisagoodrich]

Pull Request Testing

• Describe testing already performed for these changes:
  

I have updated all of the headers. In some cases, I have added Capitalization to the headers.

I have gone through GitHub and checked each file for the updated headers. https://github.com/dtcenter/METviewer/tree/feature_497_headers

I have compared the feature_497_headers branch to the develop branch in ReadTheDocs
https://metviewer.readthedocs.io/en/feature_497_headers/Users_Guide/index.html
https://metviewer.readthedocs.io/en/develop/Users_Guide/index.html

In batch.rst I changed “Template Formatting” to it’s own section per email with Julie.
Please note, the Contributor’s Guide is not viewable via ReadTheDocs. It is only available in GitHub. I’ve updated the headers in the only chapter, testing.rst.

• Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:
  
  Please feel free to triple check the headers.

• Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes there are no warnings]

• Do these changes include sufficient testing updates? [No]

• Will this PR result in changes to the test suite? [No]
  
  If yes, describe the new output and/or changes to the existing output:
  

• Please complete this pull request review by 11/3/23.
  

Pull Request Checklist

See the METplus Workflow for details.

• Review the source issue metadata (required labels, projects, and milestone).
• Complete the PR definition above.
• Ensure the PR title matches the feature or bugfix branch name.
• Define the PR metadata, as permissions allow.
  Select: Reviewer(s)
  Select: Organization level software support Project or Repository level development cycle Project
  Select: Milestone as the version that will include these changes
• After submitting the PR, select the ⚙️ icon in the Development section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
• After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
• Close the linked issue and delete your feature or bugfix branch from GitHub.

[lisagoodrich]

@jprestop, do you have time to discuss this? I'm not sure what to do. Thanks.

[jprestop]

I'm working on it... We can meet if you'd like to! :) I'm trying to make the Contributor's Guide viewable, but like you said, it's throwing an error. It's possessed. It doesn't make any sense.

…

On Wed, Oct 25, 2023 at 2:21 PM lisagoodrich ***@***.***> wrote: @jprestop <https://github.com/jprestop>, do you have time to discuss this? I'm not sure what to do. Thanks. — Reply to this email directly, view it on GitHub <#502 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AC3RUTQVCHRPTJO4EXIPHNLYBFYETAVCNFSM6AAAAAA6OKZL3CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONZZHE4TKMZRGQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Julie Prestopnik (she/her) Software Engineer National Center for Atmospheric Research Research Applications Laboratory Email: ***@***.*** *My work hours may not be your work hours. **Please do not feel obliged to reply to this email outside of your normal working hours.*

[jprestop]

@lisagoodrich Thanks for all of your work on this task. I added a few suggestions that you can just accept the changes for, however, for the top level docs/index.rst, could you please change those headers back to what they were? Let me know if you want to talk about this again, but we had discussed how the top level index wasn't really a "part" whereas the User's Guide's and Contributor's Guide's index.rst files were "parts". So, we decided just to leave the top level index.rst files alone. You can verify this by looking at the already merged METplotpy file (https://raw.githubusercontent.com/dtcenter/METplotpy/develop/docs/index.rst), the already merged METplus file (https://raw.githubusercontent.com/dtcenter/METplus/develop/docs/index.rst), and the already merged METdataio file (https://raw.githubusercontent.com/dtcenter/METdataio/develop/docs/index.rst). METcalcpy was also completed but it looks like it is not the same as the others and needs to be fixed as well (https://raw.githubusercontent.com/dtcenter/METcalcpy/develop/docs/index.rst) - apologies for missing that in PR review of METcalcpy.

[lisagoodrich]

@jprestop, I have made the changes you requested. Thank you for catching the top level index. This is very confusing. I will discuss with you how to best fix the METcalcpy top level index error. Please let me know if I need to do further work on this.

[jprestop]

Thanks so much for the updates, @lisagoodrich. I approve this request. Please let me know if you have any problems squashing and merging. If you encounter any issues, I can take care of that step.

[lisagoodrich]

@jprestop , It says "Merging is blocked". I can't merge on this branch. Sorry.