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

Move filtering/subsampling docs into a separate file #1431

Merged
merged 1 commit into from
Mar 6, 2024

Conversation

victorlin
Copy link
Member

@victorlin victorlin commented Mar 6, 2024

Description of proposed changes

This makes it possible to use in the Nextstrain docs project.

Related issue(s)

Checklist

  • Preview still looks good
  • Checks pass
  • If making user-facing changes, add a message in CHANGES.md summarizing the changes in this PR no user-facing changes

This makes it possible to use in the Nextstrain docs project.
@victorlin victorlin self-assigned this Mar 6, 2024
@victorlin victorlin marked this pull request as ready for review March 6, 2024 01:44
@victorlin victorlin requested a review from a team March 6, 2024 01:44
Copy link
Contributor

@joverlee521 joverlee521 left a comment

Choose a reason for hiding this comment

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

Nice, I forgot about the include directive!

Not asking for a change, but just curious, what prompted you to make this a separate page that can be included in the Nextstrain docs project rather than just a direct link to the Augur project?

(I might have answered my own question, this is a nice flow in the Nextstrain docs project)

@victorlin
Copy link
Member Author

what prompted you to make this a separate page that can be included in the Nextstrain docs project rather than just a direct link to the Augur project?

(I might have answered my own question, this is a nice flow in the Nextstrain docs project)

Yes, I thought this guide should be shown in a context above Augur docs, where one can see other higher-level guides in the same sidebar. The docs fetching is meant to be a temporary solution but it seems to be working well.

@victorlin victorlin merged commit b0c5010 into master Mar 6, 2024
20 checks passed
@victorlin victorlin deleted the victorlin/filter-guide-snippet branch March 6, 2024 19:24
@tsibley
Copy link
Member

tsibley commented Apr 19, 2024

…but it seems to be working well.

😬 It's full of pitfalls (both technical and human), and I'd prefer to continue to excise it rather than expand it.

@victorlin
Copy link
Member Author

The goal here was to show the subsampling guide contents both on the main docs project (because it's a commonly ask) and also directly on the augur filter doc page (so users can easily cross-reference the options) . Maybe that's not the best idea. An alternative:

Store filter-and-subsampling.rst in the main docs project and simply link to that from the augur filter docs page. If each option on the augur filter doc page (e.g. --group-by) can be made link-able, having those links from a subsampling guide housed in the main docs project should suffice.

@tsibley
Copy link
Member

tsibley commented Apr 19, 2024

Nod. I like the idea of keeping the augur filter page as a reference page and the making the guide separate, but cross-linking the two. This also keeps with our documentation organization model. The individual command-line options for augur filter can be made linkable, for sure. There's Sphinx support for it, and I've done it for Nextstrain CLI command reference pages. Implementation may be a little different for Augur since that's generating the reference pages another way.

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

Successfully merging this pull request may close these issues.

3 participants