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

Upload docusaurus [wip] #1173

Merged
merged 4 commits into from Aug 16, 2018

Conversation

Projects
None yet
2 participants
@cmdcolin
Contributor

cmdcolin commented Aug 14, 2018

This is a big overhaul of the documentation that transports gmod wiki to use docusaurus. Aided by @scottcain initial markdown translation

This PR

  • Reimplements homepage staying fairly faitthful to the original site design
  • Imports wordpress blogposts to markdown. Note that the links to old releases do not work currently but also they do not work on the main site anyways (links to older releases such as 1.11 branch and earlier do not work)
  • Allows updating documentation by putting [update docs] in commit message
  • Migrate existing quick start guide into docs (e.g. this one does not get deleted) adds a new quick-start guide based only on indexed file formats
  • Break the large configuration guide into pages. This is maybe debatable decision for the docs but it seems pretty manageable and organized in some sense, but at perhaps the expense of "ctrl+f" the entire doc
  • Break the large faq into pages, same thing
  • Move some more uncommon stuff from the "config guide" guise into a different "Other topics" section
  • Import the featureglyphs.htm into the htmlfeatures doc :)

View https://jbrowse.org/documentation/

Feedback welcome

@wafflebot wafflebot bot added the in progress label Aug 14, 2018

@rbuels rbuels added this to the 1.15.2 milestone Aug 15, 2018

@rbuels

This comment has been minimized.

Show comment
Hide comment
@rbuels

rbuels Aug 15, 2018

Collaborator

Don't forget to make a limited user on jbrowse.org for travis to use for deploys

Collaborator

rbuels commented Aug 15, 2018

Don't forget to make a limited user on jbrowse.org for travis to use for deploys

@cmdcolin

This comment has been minimized.

Show comment
Hide comment
@cmdcolin

cmdcolin Aug 16, 2018

Contributor

I think starting tomorrow I'll be updating website in prep for release

Contributor

cmdcolin commented Aug 16, 2018

I think starting tomorrow I'll be updating website in prep for release

@rbuels rbuels merged commit 765a79e into dev Aug 16, 2018

0 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
continuous-integration/travis-ci/push The Travis CI build is in progress
Details

@wafflebot wafflebot bot removed the in progress label Aug 16, 2018

@cmdcolin cmdcolin deleted the upload_docusaurus branch Aug 20, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment