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

Add docs for adding a new core pathogen #978

Open
joverlee521 opened this issue Aug 9, 2024 · 2 comments
Open

Add docs for adding a new core pathogen #978

joverlee521 opened this issue Aug 9, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@joverlee521
Copy link
Contributor

Prompted by a lot of the recent work of adding new pathogens (e.g. seasonal-cov and rabies).

We should have a documented process for adding new core pathogens.

Steps to include:

  1. Upload pathogen dataset to S3, i.e. nextstrain remote upload s3://nextstrain-data <local-path-to-jsons>
  2. Add pathogen to coreBuildPaths for routing to work correctly.
  3. Add pathogen to manifest_core.json to include pathogen in Auspice dataset dropdown and the /pathogens listing
  4. Add pathogen to coreShowcase to include pathogen tile at the top of the /pathogens page.
@joverlee521 joverlee521 added the documentation Improvements or additions to documentation label Aug 9, 2024
@genehack
Copy link
Contributor

  1. Update description.md to link to S3 datasets?

@joverlee521
Copy link
Contributor Author

  1. Update description.md to link to S3 datasets?

I'm would think this would go into a more general doc of "How to ship a pathogen build". Here, I was thinking about specifically what needs to be done within nextstrain.org.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants