MaayanLab / DRC-Portals

0 stars 0 forks source link

C2M2 Docs lacking #210

Open u8sand opened 5 months ago

u8sand commented 5 months ago

Though https://info.cfde.cloud/info/standards/C2M2 has a lot of information; someone who is completely clueless about the C2M2 will not be able to assemble a C2M2 data package with the provided information. I suggest we adopt some of the docs that were developed in the past to successfully onboard the current DCCs about C2M2 (https://docs.nih-cfde.org/en/latest/c2m2/draft-C2M2_specification/index.html).

Some areas I find missing:

mano-at-sdsc commented 5 months ago

I agree. I tried to find the source of pages like https://github.com/nih-cfde/published-documentation/wiki/TableInfo:-biosample_from_subject.tsv (e.g. from where the information the table formats explained there is coming) but couldn't locate it. Of course, from C2M2_datapackage.json, we can populate most of the content of the table, but not the explanatory text above it. We can create such pages brute-force if cannot figure out the github source page/file.

mano-at-sdsc commented 5 months ago

Thanks, @u8sand for sharing https://github.com/nih-cfde/published-documentation.wiki.git . @sxie04, are you already looking into cross-checking and putting this documentation inside DRC-Portals e.g., in a folder inside https://github.com/MaayanLab/DRC-Portals/tree/main/drc-portals/app/info/standards/markdown ? If not, we can work on it. Please let us know.

sxie04 commented 5 months ago

Hi @mano-at-sdsc, right now I'm working on quoting sections and linking to the original documentation from the Standards page. I don't believe we currently plan to have a duplicate copy of all the documentation in DRC-Portals since we are not the original creators, but we can also discuss further once I merge the newest changes.

mano-at-sdsc commented 5 months ago

Thanks, @sxie04.