Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

[Discuss] Wiki Integration #15

Closed
rushsteve1 opened this issue Apr 28, 2019 · 6 comments
Closed

[Discuss] Wiki Integration #15

rushsteve1 opened this issue Apr 28, 2019 · 6 comments
Labels
discussion Outside feedback and opinions are wanted help wanted Extra attention is needed

Comments

@rushsteve1
Copy link
Contributor

rushsteve1 commented Apr 28, 2019

We might want to have a built in or in some way integrated wiki as a knowledge base for members to reference and also to easily see who knows about the topic so that they can contact them.

From a technical standpoint a simple wiki would be easy to add. But more advanced features might warrant using an external solution.

@rushsteve1 rushsteve1 added the help wanted Extra attention is needed label Apr 28, 2019
@rushsteve1
Copy link
Contributor Author

rushsteve1 commented Apr 28, 2019

Technical ideas for a built-in RCOS wiki:

  • Organized by topic and tags
  • Sidebar of contributors to page
  • Saved in database as Diffs to allow versioning
  • Two database tables:
    • pages: the pages their tags and whatnot
    • revisions: the revisions to pages and who they were by
  • Markdown support is already in

@rushsteve1
Copy link
Contributor Author

For an external wiki here is a list of possible software solutions:
https://github.com/Kickball/awesome-selfhosted#wikis

@joshlebed
Copy link

On a non-technical note - how should we incentivize experienced and senior members of the RCOS community to contribute to the wiki? Contributions for the semester could be factored into grading, for example.

@rushsteve1
Copy link
Contributor Author

@joshlebed Perhaps factor it into part of the status reports? If you're taking time to learn something write it down for others I guess.

@rushsteve1
Copy link
Contributor Author

Features necessary for any Wiki software we use:

  • Obviously must be FOSS and self-hostable
  • If an external database is required it must support Postgres
  • Read/Write Permission controls
  • Revision history
  • Hierarchical navigation

Currently here are what I currently consider the best options:

  • DokuWiki
    • Pros: No database required, many plugins
    • Cons: Ugly by default, a bit clunky to use at times, no markdown support
  • WikiJS 2
    • Pros: Lots of features, supports markdown
    • Cons: Unfinished beta, Javascript heavy, slightly annoying UX.
  • Bookstack
    • Pros: Nice looking, supports markdown
    • Cons: "book/shelf" model is confusing

Of these three I think DokuWiki would be the best choice for now, and likely the easiest to migrate away from if we change our mind.
However, depending on the development status of WikiJS 2 I would chose that instead.

@rushsteve1 rushsteve1 added the discussion Outside feedback and opinions are wanted label Jun 4, 2019
@rushsteve1
Copy link
Contributor Author

We went with Dokuwiki. Not sure why this is still open actually.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
discussion Outside feedback and opinions are wanted help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants