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

feat(website): improve docs #3564

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(website): improve docs #3564

wants to merge 2 commits into from

Conversation

anna-parker
Copy link
Contributor

@anna-parker anna-parker commented Jan 21, 2025

partially resolves #3556

resolves #3555, resolves #3562

preview URL: https://typos.loculus.org/

Summary

  1. add missing comma
  2. replace Files with file
  3. update compression statement using @chaoran-chen's suggestion

Screenshot

PR Checklist

  • All necessary documentation has been adapted.
  • The implemented feature is covered by an appropriate test.

@anna-parker anna-parker added the preview Triggers a deployment to argocd label Jan 21, 2025
@@ -300,7 +301,7 @@ const InnerDataUploadForm = ({
<div className='sm:col-span-4 px-8'>
{dataUseTermsType === restrictedDataUseTermsOption && (
<p className='block text-sm'>
Your data will be available on Pathoplexus, under the restricted use terms until{' '}
Your data will be available on Pathoplexus, under the restricted use terms, until{' '}
Copy link
Member

@theosanderson theosanderson Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this change doesn't make sense to me. Your change to me implies the data will only be available on Pathoplexus until date X. Whereas it will be available in perpetuity, under the restricted terms until date X.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this better? Bit more explicit with "also" etc.

Until the end of the restricted period, your data will be shared on Pathoplexus with restricted use terms.
Afterwards, the use terms change to open and the data will also be released on the INSDC.

@theosanderson
Copy link
Member

theosanderson commented Jan 21, 2025

(My take is still that the existing behaviour is better re this Excel thing, but it really doesn't matter - happy to go with this) thanks for making the PR

@chaoran-chen
Copy link
Member

I don't have a strong opinion. I'm happy with the current behavior as well as with changing the text as suggested in this PR.

@@ -243,7 +243,8 @@ const InnerDataUploadForm = ({

<p className='text-gray-400 text-xs mt-3'>
Files can optionally be compressed, with the appropriate extension (<i>.zst</i>, <i>.gz</i>,{' '}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Files can optionally be compressed, with the appropriate extension (<i>.zst</i>, <i>.gz</i>,{' '}
Files can optionally be compressed using <i>.zst</i>, or <i>.gz<xz>; the FASTA file also with <i>.zip</i> or <i>.xz</i> formats.{' '}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

zip also works for metadata files.

@@ -243,7 +243,8 @@ const InnerDataUploadForm = ({

<p className='text-gray-400 text-xs mt-3'>
Files can optionally be compressed, with the appropriate extension (<i>.zst</i>, <i>.gz</i>,{' '}
<i>.zip</i>, <i>.xz</i>). For more information please refer to the{' '}
<i>.zip</i>), <i>.xz</i> is also supported specifically for FASTA files. For more
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<i>.zip</i>), <i>.xz</i> is also supported specifically for FASTA files. For more
For more{' '}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
preview Triggers a deployment to argocd
Projects
None yet
5 participants