A submission guide section with information for end contributors

[gabsie]

• [ ] As a potential data contributor, I would like to find an area of the Contribute website which will guide me in the process of submission to HCA.

Acceptance Criteria / Definition of Done

• Given I find or am directed to the HCA Ingest website
• When I visit the Submission Guide section
• Then I can find answers to my questions on data types and formats, and steps.

Tasks:

• [x] Design: decide where the guide lives
• [ ] Propose content design
• [ ] Propose design options which fit the content
• [x] Dev discussion on implementation and updates
• [x] Implementation

[gabsie]

First version of a design (still have to see about the right VF components), but can work as a prototype first. The sizing of the page is also not right yet

[gabsie]

Hey @jacobwindsor - as a start, please consider these two pages as placeholders for 2 pages from the Submission guide: https://ebi-ait.github.io/hca-ebi-wrangler-central/SOPs/dataset_suitability_SOP.html https://ebi-ait.github.io/hca-ebi-wrangler-central/SOPs/GDPR_Guidelines.html

These two pages will fall under the category of Data requirements, from the first version of the suggested design above. I will have time in the afternoon to chat through this :) Please consider also having a diagram in one of the pages, the Data Policy one will probably have the GDPR diagram in a similar format.

I will later change the copy to be contributor-focused and not wrangler focused, but the overall size and contents should be okay for you to get started.

[idazucchi]

finishing off page layout, the pages will render markdown documents

[yusra-haider]

code implementation done by @jacobwindsor. Waiting on content from @gabsie

[jacobwindsor]

https://github.com/ebi-ait/ingest-ui/pull/173

[ESapenaVentura]

@gabsie has a starter page - Working on this today

[ESapenaVentura]

Set up deadline for Friday 28th

[gabsie]

@ofanobilbao I am starting here, and we can continue working together here https://docs.google.com/document/d/1eIAsRIUmUtJaPgTMuFuHjMGCm3fhg0oefLfYeElZM-M/edit?usp=sharing I am also doing a visualisation also in Miro

[idazucchi]

gabs to send the first page for review today

[gabsie]

https://docs.google.com/document/d/1eIAsRIUmUtJaPgTMuFuHjMGCm3fhg0oefLfYeElZM-M/edit?usp=sharing

[Wkt8]

@idazucchi and @Wkt8 to review this document. Oihane has reviewed.

[gabsie]

@amnonkhen - can you please look at the code etc using the example text from the doc? I will arrive on campus and continue catching up.

[amnonkhen]

@gabsie Here is what it looks like. What do you think?

[MightyAx]

@Gabs to make minor visual changes.

[gabsie]

Hey Amnon In the file, I changed the subsections to have shorter names: https://docs.google.com/document/d/1eIAsRIUmUtJaPgTMuFuHjMGCm3fhg0oefLfYeElZM-M/edit?usp=sharing

[MightyAx]

submission guide has been deployed to dev for testing

[ESapenaVentura]

I have a couple of comments:

• Is there any way for the TOC on the left to follow the screen? if I scroll down, I would like to still see the table
• Can we change the font a bit? I don't know how to make it better, but right now the font looks very sharp and clumped.
• I would re-factor the content a bit:
  • Moving the "contribution checklist" to the top, with links to each of the different sections
  • I would put the first paragraph (The Human Cell Atlas Data Coordination Platform supports scientists in their atlas-building efforts by providing easy access to cellular-resolution data generated by the research community.) Directly below the Data requirements title.
  • I would add bulleted lists to other parts

I can create a PR for the content changes, let me know!

[ofanobilbao]

This is now live in Dev. @gabsie will review the content and edit it. Amnon showed her how to be able to edit going forward

[Wkt8]

Gabs to continue editing and then to create a PR for merging into prod / master. Alexie and Enrique to support if necessary.

[MightyAx]

deploying to staging

[MightyAx]

@gabsie

• [x] to post the minor edit required

@MightyAx / @amnonkhen

• [ ] to Commit / PR / merge to production

[gabsie]

This is ready for Prod as far as I am concerned

[idazucchi]

alexie will push this to prod today

[MightyAx]

• [x] put it on the main branch so it is deployed to staging and tested there
• [x] check it in staging manually
• [x] promote to prod.