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

Move to GitHub wikis? #2

Open
petebachant opened this issue Dec 23, 2015 · 3 comments
Open

Move to GitHub wikis? #2

petebachant opened this issue Dec 23, 2015 · 3 comments
Labels

Comments

@petebachant
Copy link
Contributor

Is it preferable to migrate from the self-hosted DokuWiki to a GitHub wiki?

Pros

  • Colocation with the issue trackers, e.g. https://github.com/UNH-OE/wave-tow-tank/issues.
  • Wikis can be cloned and edited offline with Git.
    • Allows for easier backups
  • Markdown (the default GitHub wiki markup language) is more ubiquitous and useful than the DokuWiki markup.
  • Non-reliance on UNH IT resources and infrastructure (public GitHub repos/wikis are free).
    • Less maintenance.
    • GitHub is better at defending against spam, fake accounts, etc.
  • No separate wiki account required (only a GitHub account).
  • Separate wikis for each major system or project helps keep intra-wiki links simpler and faster to add.

Cons

  • Writing math is harder.
  • Uploading files, e.g. images and PDFs, is a bit harder, though it may be smarter to host these elsewhere anyway.
  • Markup can be a little less flexible, though pure HTML is accepted along with Markdown, etc.
  • Private pages require private repos.
@petebachant
Copy link
Contributor Author

I started testing this out a bit:

@wosnik @Toby-D @iangagnon: any preference?

I like the idea w.r.t. organization and maintenance.

@iangagnon
Copy link

Tough to say. I don't have much experience with running the wiki and how difficult that is. I also haven't made any github wikis yet although it would be good to learn.

One thing about the Cons. We can get 5 private repositories while we are students for free.

@Toby-D
Copy link

Toby-D commented Jan 11, 2016

Either way is fine with me. The pros and cons don't seem to overwhelmingly
favor moving. But hey, GitHub's cool.

On Mon, Jan 11, 2016 at 3:40 PM, iangagnon notifications@github.com wrote:

Tough to say. I don't have much experience with running the wiki and how
difficult that is. I also haven't made any github wikis yet although it
would be good to learn.

One thing about the Cons. We can get 5 private repositories while we are
students for free.


Reply to this email directly or view it on GitHub
#2 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants