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

Publish Markdown and Scaladoc to the interwebs #1453

Closed
fnothaft opened this issue Mar 22, 2017 · 6 comments
Closed

Publish Markdown and Scaladoc to the interwebs #1453

fnothaft opened this issue Mar 22, 2017 · 6 comments
Labels
Milestone

Comments

@fnothaft
Copy link
Member

@fnothaft fnothaft commented Mar 22, 2017

@fnothaft fnothaft added this to the 0.22.0 milestone Mar 22, 2017
@fnothaft
Copy link
Member Author

@fnothaft fnothaft commented Mar 30, 2017

Pushed a gh-pages branch.

@fnothaft
Copy link
Member Author

@fnothaft fnothaft commented Mar 30, 2017

And here's our docs: http://bdgenomics.org/adam/

Aren't they lovely? :-p

@heuermh
Copy link
Member

@heuermh heuermh commented Mar 31, 2017

Eesh, those project docs look pretty sad. A bunch of the links and some of the MathJax formatting didn't work.

From what I can tell, we can use GitHub Pages Jekyll with the gh-pages branch. Then we could leave the markdown pages unrendered by pandoc.

As far as sequencing, do you want to merge #1461 before the 0.22.0 release then then have us look into better markdown rendering after?

@heuermh
Copy link
Member

@heuermh heuermh commented Mar 31, 2017

See also #774

@fnothaft
Copy link
Member Author

@fnothaft fnothaft commented Mar 31, 2017

Under the principle of "perfect is the enemy of good", I would rather publish a release with ugly docs than a release with no docs. That said, I'd like to merge #1461 before 0.22.0.

@heuermh
Copy link
Member

@heuermh heuermh commented Mar 31, 2017

+1

heuermh added a commit that referenced this issue Mar 31, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.