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

Link to the C2M2 GitHub pages on https://github.com/MaayanLab/DRC-Portals/blob/main/drc-portals/app/info/standards/markdown/C2M2.md #167

Open
mano-at-sdsc opened this issue Feb 9, 2024 · 5 comments

Comments

@mano-at-sdsc
Copy link
Collaborator

The current description at

https://github.com/MaayanLab/DRC-Portals/blob/main/drc-portals/app/info/standards/markdown/C2M2.md

is great, and I suppose it is evolving. It will be useful to add a link to the page

https://github.com/nih-cfde/published-documentation/wiki/Quickstart where complete details of table columns, etc., can be obtained. After, April 1st, 2024, we can edit this relevant GitHub pages, e.g., https://github.com/nih-cfde/published-documentation/wiki/Quickstart as we see fit. For example, any links that take us to https://docs.nih-cfde.org should be pointed to a corresponding respective page on the new portal, e.g., https://info.cfde.cloud/info/standards/C2M2, or to a GitHub page such as https://github.com/nih-cfde/c2m2, or https://github.com/nih-cfde/published-documentation/.

sxie04 added a commit that referenced this issue Apr 24, 2024
* Update C2M2 text (#210)
* Fix link rendering
* Handle external C2M2 doc rendering (#167)
@sxie04
Copy link
Contributor

sxie04 commented Apr 30, 2024

Hi @mano-at-sdsc I've updated the C2M2 Documentation on the portal to include the content from the original documentation pages, specifically the table descriptions. I opted not to include the Quickstart page which references the old submission pipeline, but please let me know if there is anything else you think is missing.

@mano-at-sdsc
Copy link
Collaborator Author

Hi @sxie04: Thank you. This is tremendous effort. Just some minor fixing:

  1. At https://info.cfde.cloud/documentation/C2M2#c2m2-tables, the URL in the first item: All table files listed in this summary must be bundled together, along with the C2M2 datapackage JSON Schema file (https://osf.io/vzgx9/), to create a valid C2M2 datapackage for submission to CFDE, please replace it with the current https://osf.io/c63aw/ (listed in the section https://info.cfde.cloud/documentation/C2M2#resources ).
  2. In the section https://info.cfde.cloud/documentation/C2M2#submission-prep-script : remove python from "python prepare_C2M2_submission.py". https://info.cfde.cloud/documentation/C2M2#general-steps step 6 lists the full command.
  3. Reference tables (not part of the submission package): If not already somewhere, for our internal record, perhaps we can include a link to the Reference tables (which links to https://osf.io/m3a85/) as in the image below from the github.com/nih-cfde repo. We will have to change these if there were such an indication from the higher CFDE leadership.
  4. In the section general steps: https://info.cfde.cloud/documentation/C2M2#general-steps: some URLs may need fixing:

image

sxie04 added a commit that referenced this issue May 10, 2024
* reorganize and update links and content in C2M2 docs (#167)
* convert all docs to MDX
* improve MDX styling and rendering
@sxie04
Copy link
Contributor

sxie04 commented May 14, 2024

Hi @mano-at-sdsc I tried to address most of your comments in the latest deployment, with the exception of the 0-numbering at Submission Prep Script General Steps because this section is pulled directly from the original Wiki documentation.

@mano-at-sdsc
Copy link
Collaborator Author

Thank you very much, @sxie04 .

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