-
Notifications
You must be signed in to change notification settings - Fork 3
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
Conversation
no longer used
no longer used
no longer used
no longer used
…r/METdataio into feature_337_xml_spec_doc
outdated information, replacing XML specification information in the load_data.rst file
…r/METdataio into feature_337_xml_spec_doc
…feature_337_xml_spec_doc
…feature_337_xml_spec_doc
…feature_337_xml_spec_doc
…feature_337_xml_spec_doc
…_val elements in the exmample
…and Troubleshooting sections
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: Julie Prestopnik <[email protected]>
For clarification, I added an explanation in one of the bullets and also
added spacing around the redirect.
…On Wed, Nov 6, 2024 at 2:28 PM Julie Prestopnik ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/Users_Guide/load_data.rst
<#351 (comment)>:
>
-In the METdataio/METdbLoad/sql/scripts directory, there are two configuration files:
+ mysql -udbuser -pdbpasswd dbtable_name</path-to-METdataio/METdbLoad/sql/mv_mysql.sql
Phew! I'm glad you're paying attention. Please pardon my ignornace!
—
Reply to this email directly, view it on GitHub
<#351 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AA4UJHQPMQAPUPVLZOQFUT3Z7KCWJAVCNFSM6AAAAABRJRI2I6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDIMJZGQ2TQNRSHE>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
@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.
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. |
…Clean up some formatting, migrated some content from the Insatllation section to this section.
|
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.
…On Thu, Nov 7, 2024 at 3:51 PM Julie Prestopnik ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/Users_Guide/load_data.rst
<#351 (comment)>:
>
-Generate the XML Specification File
+ - Replace *path-to-METdataio* with the path where the METdataio source code is saved
⬇️ Suggested change
- - Replace *path-to-METdataio* with the path where the METdataio source code is saved
+ - Replace *dbuser* with the username
+ - Replace *dbpasswd* with the password
+ - Replace *dbtable_name* with the appropriate database name that begins with **mv** (e.g. mv_xyz )
+ - Replace *path-to-METdataio* with the path where the METdataio source code is saved
It looks like we lost the other entries that we had previously, I think.
Please correct me if I am wrong.
—
Reply to this email directly, view it on GitHub
<#351 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AA4UJHSCTWQE5BDAWOWZADTZ7PVGFAVCNFSM6AAAAABRJRI2I6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDIMRSGMYTMMBSGE>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
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"? |
Co-authored-by: Julie Prestopnik <[email protected]>
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. |
There was a problem hiding this 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.
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
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.
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