Closed nozomione closed 3 weeks ago
@nozomione I think the table looks good, but I don't think we want a table if someone downloads metadata for a single project. Then you would just have a one line table. If someone downloads metadata for a single project, I think we should keep the one line sentence that we have in the existing READMEs if that's possible.
So for portal-wide metadata you would have the table as you mentioned above.
Then for an individual project metadata download you would have: https://github.com/AlexsLemonade/scpca-portal/blob/f6708c8749929abd0e399bc97dde1eceddeaca6d/api/scpca_portal/templates/readme/single_cell.md?plain=1#L71-L73
I naively assume you could add a check to see if you have more than one project. If there's more than one project then make the table, otherwise keep the existing line.
@allyhawkins, I've made the adjustment based on your feedback (the template context will be changed to a list that allows for length check!) 👍 Thank you, Ally!
@allyhawkins, I've made the adjustment based on your feedback (the template context will be changed to a list that allows for length check!) 👍 Thank you, Ally!
The new update looks good!
closed with #792
Context
Related issue: Additional Restrictions for Portal-wide metadata download
In #781, we've updated the context and context variable name of README template (
templates/readme/metadata_only.md
) toprojects
. This update will enable the table below to be displayed in a downloadableREADME.md
file for the portal-wide metadata-only download.Problem or idea
We should use the
projects
context to generate the above table in the README template.Solution or next step
additional_terms
projects
and render the table as follows: