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

Auspice contributing docs contain version information #832

Closed
kairstenfay opened this issue Dec 9, 2019 · 4 comments
Closed

Auspice contributing docs contain version information #832

kairstenfay opened this issue Dec 9, 2019 · 4 comments

Comments

@kairstenfay
Copy link
Contributor

The contributing information in docs-src/docs/contributing/overview.md contains information about Releasing New Versions of Auspice.

It seems out of place. Namely, we wouldn't expect or want third-party contributors to release new Auspice versions. Can this paragraph find a better place to live?

Also -- my goal is to use most of this page (minus "Releasing new versions...") for the content of a new CONTRIBUTING.md.

@jameshadfield
Copy link
Member

jameshadfield commented Dec 9, 2019

Agree -- release instructions should be moved to github.com/nextstrain/documentation/

my goal is to [make] a new CONTRIBUTING.md

That'd be great, but please make sure it also appears in the built (docusaurus / github-pages) documentation. Have a look at how the CHANGELOG.md appears in both, you may want to do it that way.

@kairstenfay
Copy link
Contributor Author

kairstenfay commented Dec 9, 2019

Hey James, I'm having trouble seeing how CHANGELOG.md is converted to HTML. Could you please point me more specifically to the script that does that?

@kairstenfay
Copy link
Contributor Author

kairstenfay commented Dec 9, 2019

Or rather, I'm having trouble seeing where CHANGELOG.md gets pulled into the built docs folder under /releases

@jameshadfield
Copy link
Member

Closed by #833

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