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

docs: document nextalign-like use-case #1456

Open
ivan-aksamentov opened this issue May 17, 2024 · 1 comment
Open

docs: document nextalign-like use-case #1456

ivan-aksamentov opened this issue May 17, 2024 · 1 comment
Labels
docs Documentation related issues good first issue Good for newcomers help wanted Extra attention is needed

Comments

@ivan-aksamentov
Copy link
Member

ivan-aksamentov commented May 17, 2024

Related: nextstrain/seasonal-cov#2

After release of Nextclade v3 and removal of a standalone nextalign binary, some older workflows relying on Nextalign are left in an awkward state.

There is a migration guide and it's linked in the docs, but there is no dedicated section in the docs about the alignment-only use-cases outside of migration. And the old Nextalign docs are now 404.

We should probably document the Nextalign-like usage in the main Nextclade docs, i.e. using Nextclade v3 without a dataset and providing individual files using --input-* args instead. The invocation of Nextclade v3 with individual args is mostly the same or is very similar to what Nextalign v2 invocation used to be. And I believe that swapping nextclade in place of nextalign executable should either work or produce somewhat informative errors.

Documenting it better would allow for smoother transition to v3 for v1 and v2 users and also highlight that Nextclade v3 can be used as an aligner even where there's no dataset for a particular organism.

Would be amazing if the old links to the Nextalign docs can somehow redirect to the new docs. Or perhaps we could create a deprecation/removal page on that address, with explanation of how to migrate.

@victorlin
Copy link
Member

the old Nextalign docs are now 404.

Would be amazing if the old links to the Nextalign docs can somehow redirect to the new docs.

Not sure which links you are referring to, but we already have a redirects system on other RTD projects (e.g. Augur) - it can be easily set up here too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related issues good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants