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

Pre vs berkeley DO NOT MERGE HERE #275

Draft
wants to merge 30 commits into
base: main
Choose a base branch
from
Draft

Pre vs berkeley DO NOT MERGE HERE #275

wants to merge 30 commits into from

Conversation

turbomam
Copy link
Member

tools and sources for documenting the legacy/10 to berkeley/11 migration and its impacts

not necessarily intended for merging. if it is going to be merged, the images should be bundled up into a directory and so on. could be merged into the origin repo.

Copy link

github-actions bot commented Oct 15, 2024

PR Preview Action v1.4.8
🚀 Deployed preview to https://microbiomedata.github.io/berkeley-schema-fy24/pr-preview/pr-275/
on branch gh-pages at 2024-10-21 16:55 UTC

@sierra-moxon
Copy link
Member

sierra-moxon commented Oct 15, 2024

@turbomam - thanks a bunch! - this is terrific.

  • should the doc preview GH action show the changes or just register that the changes are deployable? (I am getting 404 errors when I click on the provided link - maybe b/c this is on the fork...not sure)
  • will this be in Berkeley schema but not in NMDC schema documentation?
    • I think it would be nice to add only the pre_vs_berkeley.md file, as "Migration Guide for NMDC schema 10.9.1 -> 11.0.1)" linked in the left-hand nav bar on the main index of the NMDC schema documentation page.
    • It would also be nice to link this single markdown file from the release notes here: https://github.com/microbiomedata/nmdc-schema/releases/tag/v11.0.0
      If you have any overarching summary text explaining why we made these changes and/or how they are all related (e.g. Why are we bundling this set of changes in a major release? Maybe it's simply that we do a major release once a year. That paragraph explanation would be a nice-to-have addition at the top of the single markdown file).

Copy link
Member

@sierra-moxon sierra-moxon left a comment

Choose a reason for hiding this comment

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

  • add single markdown file link to left hand nav bar on main NMDC index doc page as "NMDC Schema Migration Guide from 10.9.1 -> 11.0.1"
  • check that the doc preview is not showing the changes b/c this PR is on a fork
  • add link to migration guide to the release notes here: https://github.com/microbiomedata/nmdc-schema/releases/tag/v11.0.0
  • Add an over-arching summary paragraph explaining why this release bundles these changes. Maybe it's a yearly release, or maybe things were blocking the development of the submission/data portal that required a set of these changes, and additional ones were bundled as a convenience. Just a high-level summary would be very helpful.

pre_vs_berkeley.md Outdated Show resolved Hide resolved
pre_vs_berkeley.md Outdated Show resolved Hide resolved
pre_vs_berkeley.md Outdated Show resolved Hide resolved
| | WorkflowExecution | |

For example, `MetagenomeAnnotationActivity` used to be located in the hierarchy
`Activity.WorkFlowExecutionActivity`, but now it and 11 similar classes are located in

Choose a reason for hiding this comment

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

I'm not familiar with this notation. Is WorkflowExecutionActivity an attribute of Activity? It reminds me of instance.attribute notation.

Copy link

@eecavanna eecavanna Oct 15, 2024

Choose a reason for hiding this comment

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

A left arrow might work well as a delimiter (e.g. ParentChildGrandchild).

image

2190 | ← | Leftwards Arrow
-- | -- | --
  |   | → | 20EA ◌⃪ combining leftwards arrow overlay

Copy link
Member Author

Choose a reason for hiding this comment

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

I like this but want to discuss with others. I'm adding a "Conventions" line explaining this notation for now.

pre_vs_berkeley.md Outdated Show resolved Hide resolved

The leagcy `BiosampleProcessing` class (including `Pooling`, `LibraryPreparation`) and some classes that were previously
direct subclasses of `PlannedProcess` (`Extraction`, `SubSamplingProcess`, `MixingProcess`, `FiltrationProcess`,
`ChromatographicSeparationProcess`) have been re-rooted into a new `MaterialProcessing` class.

Choose a reason for hiding this comment

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

Suggested change
`ChromatographicSeparationProcess`) have been re-rooted into a new `MaterialProcessing` class.
`ChromatographicSeparationProcess`) now descend from a new class, named `MaterialProcessing`.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don;t think either of the wordings we are using are really defined in the LinkML specs or in the nmdc-schema

pre_vs_berkeley.md Outdated Show resolved Hide resolved
pre_vs_berkeley.md Outdated Show resolved Hide resolved
pre_vs_berkeley.md Outdated Show resolved Hide resolved
turbomam and others added 2 commits October 16, 2024 12:38
Co-authored-by: eecavanna <134325062+eecavanna@users.noreply.github.com>
Co-authored-by: eecavanna <134325062+eecavanna@users.noreply.github.com>
@sierra-moxon
Copy link
Member

Before we do too much additional work here, can we confirm that this will move to the NMDC schema and not be accepted into this deprecated fork?

@turbomam
Copy link
Member Author

turbomam commented Oct 16, 2024

Before we do too much additional work here, can we confirm that this will move to the NMDC schema and not be accepted into this deprecated fork?

yes, I will move it

I'm working on it in the berkeley-schem-fy24 because I have my local nmdc-schema checkout on v10.9.1 so I can compare the docuemtnation

@turbomam turbomam changed the title Pre vs berkeley Pre vs berkeley DO NOT MERGE HERE Oct 16, 2024
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