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

Import auspice docs #8

Closed
jameshadfield opened this issue Sep 24, 2020 · 3 comments
Closed

Import auspice docs #8

jameshadfield opened this issue Sep 24, 2020 · 3 comments
Assignees

Comments

@jameshadfield
Copy link
Member

This is a progress-tracker type issue to track the incorporation of auspice documentation into docs.nextstrain.org. The current docs are stored at https://github.com/nextstrain/auspice/tree/master/docs-src/docs, are in markdown format (with YAML frontmatter) and are rendered at https://nextstrain.github.io/auspice. The gdoc contains a mapping of how they shall fit into the new docs TOC structure

@eharkins
Copy link
Contributor

eharkins commented Oct 1, 2020

If the current state of the augur subproject / submodule set up [1] is to serve as a precedent / template for auspice, we should create a read the docs subproject for auspice, which builds from the documents in the auspice git repo and displays reference material in a distinct RTD domain, presumably https://docs.nextstrain.org/projects/auspice - which can be linked in the reference/auspice section of this project.

[1] #10 (comment)

jameshadfield added a commit to nextstrain/auspice that referenced this issue Oct 1, 2020
As part of our migration of all nextstrain-docs to RTD and docs.nextstrain.org
this commit switches Auspice to using RTD.

There is further work needed in terms of organisation structure, using pages here
under docs.nextstrain.org's RTD page (as opposed to the Auspice subproject), but this
migration paves the way.

No content changes, but lots of syntax changes etc

See nextstrain/docs.nextstrain.org#8 for context.
@jameshadfield
Copy link
Member Author

we should create a read the docs subproject for auspice, which builds from the documents in the auspice git repo

#19 achieves this -- @eharkins could you create a RTD domain for auspice using that? (There's still work to be done -- that PR just migrates auspice to RTD, it doesn't modify the contents structure at all)

eharkins added a commit that referenced this issue Oct 6, 2020
this adds documents from the
auspice submodule by adding
paths to those documents
in the toctree(s) of this project
thereby including them in the
sidebar for docs.nextstrain.org
eharkins added a commit that referenced this issue Oct 6, 2020
@eharkins
Copy link
Contributor

eharkins commented Oct 21, 2020

The bulk of this work is done so I am closing since we have #17 to ensure auspice-repo-stored docs are up to date in this project. If #27 pans out, there will be some work again here to change implementation of including these docs.

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

No branches or pull requests

2 participants