search

microbiomedata / NMDC_documentation

Document workflows, schemas, and portal
https://nmdc-documentation.readthedocs.io
2 stars 3 forks source link

draft ADR for schema refactor #36

Closed mslarae13 closed 8 months ago

mslarae13 commented 8 months ago

@anastasiyaprymolenna , @aclum , @SamuelPurvine

See the "In Progress" section of this ADR. I need some more information from you to round these out.

turbomam commented 8 months ago

Wow this evolved nicely over vacation

mslarae13 commented 8 months ago

I'd like to merge this in by Monday so we can put the link into the DOE report. Reviews PLEASE read and comment in your review anywhere I misspoke or if I missed anything!

@emileyfadrosh FYI

eecavanna commented 8 months ago

I'm done reviewing this. Thanks for writing it up!

turbomam commented 8 months ago

@mslarae13 this is really good. The comments that appear form me above were written on the 3rd, but they were only visible to me until @aclum helped me release them to the public on the the 5th. I apologize for not checking in with you sooner. I think we can consider most of them low priority discussion starters.

I have opened a PR on this branch that emphasizes changing the syntax for referring to schema elements by either linking them or putting just the element name in backticks, since backticks mean this is something you would find literally in a code file or on the command line.

I also

I made small changes to almost every line, so the GH diff erroneously makes it look like I overwrote the whole thing.

Here's what it looks like, with my suggested changes, when rendered from Markdown.

If you don't want to accept my PR as is, I can help to add the parts that you would accept in individually.

mslarae13 commented 8 months ago

@turbomam I'll look at your PR from my branch. But can we call this one done (pending a couple comment responses).. merge my changes into your PR, and then I'll review? I'd like to do your updates separately.

eecavanna commented 8 months ago

Thanks for making those changes and responding to all my feedback, @mslarae13. I am done re-reviewing and responding to all the unresolved conversations I was involved in.