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 #19

Open
2 tasks
mslarae13 opened this issue Apr 12, 2023 · 1 comment
Open
2 tasks

Documentation Update #19

mslarae13 opened this issue Apr 12, 2023 · 1 comment

Comments

@mslarae13
Copy link
Contributor

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.

  • Updating Award vs Publication vs Data DOI
    I think we can write this documentation differently.. and we should update the text here.

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).

  • How to identify the thing you're to click on or specifically looking for in the submission portal
    software usually does this by picking a different font. Can Yan preserve font difference?
    Consolas or italics
@dwinston
Copy link
Contributor

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

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

No branches or pull requests

2 participants