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): generate metadata docs from config #3477

Merged
merged 4 commits into from
Jan 14, 2025

Conversation

anna-parker
Copy link
Contributor

@anna-parker anna-parker commented Dec 20, 2024

resolves ##2375, pathoplexus/pathoplexus#245, #3013

pathoplexus preview URL: https://preview-standardize-metadata-docs.pathoplexus.org/docs/concepts/metadataformat

Summary

  1. Creates a metadata description table for the docs directly from the values.yaml config to avoid duplication and future errors, also allowing different input fields for each organism.
  2. Generates a tsv with all metadata fields users can input with their descriptions
  3. Adds a desired metadata parameter to annotate metadata fields that we would like users to upload if possible.

Screenshot

Results of using this PR in pathoplexus/pathoplexus#335

Screen.Recording.2024-12-23.at.11.02.01.mov

Future work

  • After metadata definitions and guidance fields have been reviewed in Pathoplexus it would be good to update them here as well.

Copy link
Contributor

@fhennig fhennig left a comment

Choose a reason for hiding this comment

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

Just a few minor things, looks great overall! Very useful!!

website/src/utils/groupFieldsByHeader.ts Show resolved Hide resolved
website/src/types/config.ts Show resolved Hide resolved
website/src/pages/[organism]/metadata-overview/index.ts Outdated Show resolved Hide resolved
website/src/components/OrganismTableSelector.tsx Outdated Show resolved Hide resolved
website/src/components/OrganismTableSelector.tsx Outdated Show resolved Hide resolved
@anna-parker anna-parker requested a review from fhennig January 13, 2025 13:29
@chaoran-chen chaoran-chen added the preview Triggers a deployment to argocd label Jan 13, 2025
Copy link
Contributor

@fhennig fhennig left a comment

Choose a reason for hiding this comment

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

Thanks!

@anna-parker anna-parker force-pushed the generate_metadata_docs branch from efd0797 to 96487ce Compare January 14, 2025 13:48
@anna-parker anna-parker merged commit dcd019d into main Jan 14, 2025
20 checks passed
@anna-parker anna-parker deleted the generate_metadata_docs branch January 14, 2025 14:44
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
Development

Successfully merging this pull request may close these issues.

3 participants