dwinston
commented
1 year ago schema documentation needs update: https://nmdc-documentation.readthedocs.io/en/latest/reference/metadata/combined_schema_docs.html
It lists version: 2.1.0, but the current version is 7.5.0 (see https://microbiomedata.github.io/nmdc-schema/ -- just link to that?). Related, links to schema elements (e.g. at the top of https://nmdc-documentation.readthedocs.io/en/latest/reference/metadata/MAGBin.html) are of the form e.g. https://microbiomedata/meta/MAGBin which does not resolve (should be e.g. https://w3id.org/nmdc/MagBin).
/cc @turbomam
A lot of documentation is all over the place, repetitive, missing, or not formatted correctly for the diataxis framework.
A lot of updates need done, but below are a few comments from writing the Submission Portal User Guide that we should keep in mind when fixing the documentation.
Data DOI vs Award DOI is confusing...
the specific Award DOI should be entered, along with selecting the checkbox for this option. If the data was not generated at a DOE User Facility, a valid data DOI can be entered. An award DOI, and data DOIs are not the same as a publication DOI, and would be issued through a separate resource as a unique persistent identifier (e.g., 10.48443/e4zf-b917).