search

Hoohm / dropSeqPipe

A SingleCell RNASeq pre-processing snakemake workflow
Creative Commons Attribution Share Alike 4.0 International
147 stars 47 forks source link

migrate wiki to mkdocs+travis+gh-pages #51

Closed grst closed 6 years ago

grst commented 6 years ago

As discussed, I quickly tried to migrate the wiki to mkdocs. Actually it was pretty easy as it just compiles the markdown files from wiki.

See it in Action: https://grst.github.io/dropSeqPipe/

It uses travis CI to build the site and deploy it to gh-pages. All you have to do is to generate a github access token and add it to the travis-settings of the repository as described here: https://docs.travis-ci.com/user/deployment/pages/

The variable name for the token is called GITHUB_PAT.

Feel free to merge or just leave the wiki as it is, if it's easier for you to maintain.

Hoohm commented 6 years ago

This looks really cool! I'd have to restructure it a bit to make it clean, but that is amazing! I'm gonna look into it this week :)

seb-mueller commented 6 years ago

Hir @grst. The mkdocs version looks indeed very nice. I was wondering what other perks come with this transition other than appearance though? Just curious!

Also, once this is route is choosen (i.e. the PR accepted), how is it kept updated. As far as I can tell this creates a doc directory, so changes are part of the github repository itself rather than the "extra" wiki (which is then made obsolete)?

If this is the case, an obvious advantage would be to update the documentation along with the changes on the same commits or branches..

grst commented 6 years ago

The major advantage of the change imho is that the community can contribute to the documentation through PRs.