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

Feature 337 xml spec doc #351

Merged
merged 63 commits into from
Nov 12, 2024
Merged

Feature 337 xml spec doc #351

merged 63 commits into from
Nov 12, 2024

Conversation

bikegeek
Copy link
Collaborator

@bikegeek bikegeek commented Nov 6, 2024

Pull Request Testing

  • Describe testing already performed for these changes:

  • verified tests still pass for test_xml.py

  • verified that updates to the XML schema (to accommodate listing data files individually) successfully load the listed files (via METviewer docker)

  • verified GHA tests all pass

  • visually checked the content on ReadTheDocs

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

  • read the User's Guide section, section 4 Background

    • verify that content is organized and instructions for setting up XML specification files is correct
  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]

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

  • Will this PR result in changes to the test suite? [No]

    If yes, describe the new output and/or changes to the existing output:

  • Do these changes introduce new SonarQube findings? [No]

    If yes, please describe:

  • Please complete this pull request review by [for RC1 release].

Pull Request Checklist

See the METplus Workflow for details.

  • Add any new Python packages to the METplus Components Python Requirements table.
  • 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) and Development issue
    Select: Milestone as the version that will include these changes
    Select: Coordinated METplus-X.Y Support project for bugfix releases or METdataio-X.Y.Z Development project for official releases
  • 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.

bikegeek and others added 30 commits October 21, 2024 12:08
outdated information, replacing XML specification information in the load_data.rst file
@bikegeek
Copy link
Collaborator Author

bikegeek commented Nov 6, 2024 via email

@jprestop
Copy link
Collaborator

jprestop commented Nov 6, 2024

@bikegeek What do you think about changing the title from "Background" to "Using METdbLoad"? I feel like "Background" doesn't cover the scope of the documentation well enough.

Also if you agree, please consider updating this section as well.
Perhaps this section could say something like "Download the latest release" (and include a link to the releases page) or clone the METdataio repository with only "git clone https://github.com/dtcenter/METdataio" in the code block.
And this section with these instructions:

cd [install]/metviewer
mysql -u[db_username] -p[db_password] -e'create database [db_name];'
mysql -u[db_username] -p[db_password] [db_name] < sql/mv_mysql.sql

could be moved to the new page as an example under "Before using the METdbLoad module, the database must exist and have the proper permissions (i.e. grant privileges to insert, delete, update, and index)." And then the Create Database section could just be removed or could point to the new, potentially renamed, "Using METdbLoad" page.

@bikegeek
Copy link
Collaborator Author

bikegeek commented Nov 7, 2024

  • Moved content related to database creation from the Installation section to the Using METdbLoad section
  • Cleaned up some wording in the METdbLoad section

@bikegeek
Copy link
Collaborator Author

bikegeek commented Nov 7, 2024 via email

@jprestop
Copy link
Collaborator

jprestop commented Nov 7, 2024

I replaced what was originally there with this text, which was originally
under the Installation section. Is that what you're wondering about? I
also created a new section header:
Create an XML Load Specification Document
where instructions for the XML load specification file, so it is consistent
with the Create Database section. Apologies for making further changes to
the documentation.

I'm sorry, @bikegeek, I'm not sure what you are referring to in this comment with regard to "I replaced what was originally there with this text". Where is "there"?

@jprestop
Copy link
Collaborator

jprestop commented Nov 11, 2024

Hi @bikegeek. Please take a look at this comment with suggested changes.

I accepted the suggestion, is it not showing up?? I redid the accept and resolved the conversation.

And, I’m not sure what you were referring to in this comment.

I moved the database instructions from the Installation section to the using METdbLoad section, that is what I meant.

Copy link
Collaborator

@jprestop jprestop left a comment

Choose a reason for hiding this comment

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

@bikegeek Thanks for all of your work on this task and for iterating with me. I know this was a huge effort. I think it will be really helpful for users and appreciate all of your hard work and effort. I approve this request.

@bikegeek bikegeek merged commit b412b98 into develop Nov 12, 2024
10 checks passed
@bikegeek bikegeek deleted the feature_337_xml_spec_doc branch November 12, 2024 22:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏁 Done
Development

Successfully merging this pull request may close these issues.

Generate User's Documentation for XML specification file
2 participants