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

Documentation update #1321

Merged
merged 12 commits into from
Apr 25, 2024
Merged

Conversation

gesinaphillips
Copy link
Collaborator

@gesinaphillips gesinaphillips commented Apr 15, 2024

This PR does two main things:

  • Deprecates field files that were being automatically generated based on previous gen YAML table schema files.
    • I was really not sure how we want to do this since I know we want to keep the files rather than deleting. I chose to go with in-place _deprecated directories, but an alternative is to have a top-level _deprecated directory with sub-dirs that mirror the original locations of the deprecated files. E.g. docs/field-assays.yaml -> _deprecated/docs/field-assays.yaml. This would consolidate things better but may be somewhat confusing as a directory.
    • Or we could just dump them all in one folder.
    • Anyway let me know what you think.
    • Went with top-level _deprecated directory.
  • Updates documentation to be more correct.
    • Many out-of-date sections revised.
    • Replaced offline parameter on Upload with no_url_checks as there is no longer a true offline validation path. However, previous gen validation tries to run online URL checks unless they are explicitly turned off, so this is necessary for testing. This change also allows for user-facing documentation for validate_upload.py to hand-wave the portion about obtaining a Globus token, as that functionality can be turned off (this does of course mean that a user could validate locally and still have URL check errors when they submit their upload, but that seems like a small trade-off considering the currently busted status). This update allows for a (potentially temporary) state of correct user-facing documentation for how to use validate_upload.py to validate an upload's directory schema.

@gesinaphillips gesinaphillips marked this pull request as ready for review April 16, 2024 20:23
@jpuerto-psc
Copy link
Collaborator

jpuerto-psc commented Apr 24, 2024

@gesinaphillips I think I prefer the method of having a single _deprecated directory at the top level and having all deprecated files live underneath that in the same directory tree structure that they currently live in. Having _deprecated all throughout the project makes it a bit confusing to read through. Once you've made that change, I'm happy to approve.

@gesinaphillips
Copy link
Collaborator Author

@gesinaphillips I think I prefer the method of having a single _deprecated directory at the top level and having all deprecated files live underneath that in the same directory tree structure that they currently live in. Having _deprecated all throughout the project makes it a bit confusing to read through. Once you've made that change, I'm happy to approve.

Having slept on this a bit, I agree @jpuerto-psc. On it!

@gesinaphillips gesinaphillips merged commit 70a0201 into main Apr 25, 2024
8 checks passed
@gesinaphillips gesinaphillips deleted the phillips/validate_upload_readme_revisions branch April 25, 2024 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants