# Wiki overhaul

**URL:** <https://forums.sourceruns.org/t/wiki-overhaul/3003>\
**Category:** Meta\
**Created:** [March 11, 2018, 11:08pm UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003 "2018-03-11T23:08:48Z")\
**Posts on this page:** 18\
**Page:** 1

<div class="post-metadata">

**Author:** ![Cameron\_D](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/cameron_d/32/251_2.png) [@Cameron\_D](https://forums.sourceruns.org/u/Cameron_D)\
**Post date:** [March 11, 2018, 11:08pm UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/1 "2018-03-11T23:08:48Z")

</div>

With most of the work of updating the forums done it’s now time to look at updating the wiki.

It’s currently running MediaWiki which is far too heavy/complex etc. for our needs, so I’m starting this thread as a place to discuss what we should change.

The three main options mentioned are:

# Discourse

Complete integration with the forums.  
Discourse has ‘wiki posts’ built in. They can be edited by any user at trust level one or higher.

We could either use existing forum categories as the main category for each page, and the tagging system for additional categories **or** make a wiki category and just use tags for page categorisation.

It should be pretty easy to write a small script that uses the Discourse API to render wiki pages at their existing [wiki.sourceruns.org](http://wiki.sourceruns.org) location.

Downsides are: no [[easy intra wiki links]] (could make a Discourse plugin to do that though), no table of contents, editing is done entirely seperate from the pages themselves.

# Wiki.js

[https://wiki.js.org/](https://wiki.js.org/)

Looks to be a fairly simple wiki with all the key feature we need.  
Shouldn’t be too hard to integrate with the forums for authentication – wiki.js uses passport.js for auth, and there is a passport.js extension for Discourse SSO.

Downsides:

- Is JavaScript running on a server
- MongoDB

# GitBook

> **[GitBook · Documentation made easy](https://www.gitbook.com/)**
>
> GitBook is where you create, write and organize documentation and books with your team.

Similar to wiki.js in the sense that it’s markdown files stored in git, but lacks any kind of frontend for editing, because it is built more for static documentation.

# Other Options?

There are a million different platforms for running a wiki on, so definitely open to other suggestions…

---

<div class="post-metadata">

**Author:** ![BitRain](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/bitrain/32/208_2.png) [@BitRain](https://forums.sourceruns.org/u/BitRain)\
**Post date:** [March 12, 2018, 5:53am UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/2 "2018-03-12T05:53:15Z")

</div>

Gitbook does have an editor, looks like this:

 ![image](https://forum-content.sourceruns.org/original/1X/d4d96bfaa83dac5657b91e1918ba1b3c329f0ddb.png)

I’d say the main issue with GitBook is that you’re limited to 5 contributors for each project that are able to use the editor directly in the project, anyone that wants to contribute externally/publicly would have to submit a pull request to a GitHub repository connected to the project.

Then that could be a plus depending how you look at it…

---

<div class="post-metadata">

**Author:** ![Cameron\_D](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/cameron_d/32/251_2.png) [@Cameron\_D](https://forums.sourceruns.org/u/Cameron_D)\
**Post date:** [March 12, 2018, 6:13am UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/3 "2018-03-12T06:13:11Z")

</div>

Ah my bad. The 5 contributors was the main downside I could remember, but I think you can self-host it which lifts that limit.

I’ve been reading through wiki.js and it looks very simple to integrate authentication with the forums, so I currently think that is the best option.

---

<div class="post-metadata">

**Author:** ![traderain](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/traderain/32/118_2.png) [@traderain](https://forums.sourceruns.org/u/traderain)\
**Post date:** [March 12, 2018, 9:50am UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/4 "2018-03-12T09:50:01Z")

</div>

Replacing MongoDB is in development fo wiki.js so that won’t really be a downside so I think that would be the best option.

---

<div class="post-metadata">

**Author:** ![Cameron\_D](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/cameron_d/32/251_2.png) [@Cameron\_D](https://forums.sourceruns.org/u/Cameron_D)\
**Post date:** [March 12, 2018, 10:01am UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/5 "2018-03-12T10:01:34Z")

</div>

Oh cool, just checked dev, Postgres and Redis is the same as the forums, so come 2.0 release I can just make them use the same DB instances as the forum.

Also these days I don’t think Mongo is too bad, but it’s still fun to hate on.

Going to try set up a test instance and make auth work with the forums.

---

<div class="post-metadata">

**Author:** ![Cameron\_D](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/cameron_d/32/251_2.png) [@Cameron\_D](https://forums.sourceruns.org/u/Cameron_D)\
**Post date:** [March 15, 2018, 10:09pm UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/6 "2018-03-15T22:09:42Z")

</div>

[https://opencollective.com/wikijs/updates/wikijs-20-under-development](https://opencollective.com/wikijs/updates/wikijs-20-under-development)

I vote we wait a month to see whether or not a beta arrives in that time. That way we can build a proper theme that fits in with the rest of the site design and linking logins to the forums will be much easier.

That said, migrating content across is going to take time so maybe I’ll put the test instance I set up yesterday back online so people can start migrating content, that way we can just upgrade to a 2.0 instance when we’re ready to go live.

---

<div class="post-metadata">

**Author:** ![JamieOnUbuntu](https://b-cdn.sourceruns.org/letter_avatar_proxy/v4/letter/j/46a35a/32.png) [@JamieOnUbuntu](https://forums.sourceruns.org/u/JamieOnUbuntu)\
**Post date:** [March 17, 2018, 3:09pm UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/7 "2018-03-17T15:09:35Z")

</div>

How do I log in to the existing Wiki right now? I can’t seem to log in now that the forum is using Discourse. The “Log in” button just takes me to a [404](https://forums.sourceruns.org/index.php?action=login).

---

<div class="post-metadata">

**Author:** ![Cameron\_D](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/cameron_d/32/251_2.png) [@Cameron\_D](https://forums.sourceruns.org/u/Cameron_D)\
**Post date:** [March 17, 2018, 10:19pm UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/8 "2018-03-17T22:19:40Z")

</div>

Oh yeah right. I’ll see if I can make something work today for logging into the old one

---

<div class="post-metadata">

**Author:** ![Cameron\_D](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/cameron_d/32/251_2.png) [@Cameron\_D](https://forums.sourceruns.org/u/Cameron_D)\
**Post date:** [March 18, 2018, 5:25am UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/9 "2018-03-18T05:25:54Z")

</div>

Got wiki logins working again, for the time being 👍

* * *

> [@Cameron\_D](#):
>
> it looks very simple to integrate authentication with the forums

I was wrong.

Mostly because you can’t seem to enable debug logs without setting up a full dev environment for wiki.js.

---

<div class="post-metadata">

**Author:** ![JamieOnUbuntu](https://b-cdn.sourceruns.org/letter_avatar_proxy/v4/letter/j/46a35a/32.png) [@JamieOnUbuntu](https://forums.sourceruns.org/u/JamieOnUbuntu)\
**Post date:** [March 19, 2018, 11:12pm UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/10 "2018-03-19T23:12:07Z")

</div>

Thanks, your new wiki-login subdomain is working fine for me 🙂

---

<div class="post-metadata">

**Author:** ![Cameron\_D](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/cameron_d/32/251_2.png) [@Cameron\_D](https://forums.sourceruns.org/u/Cameron_D)\
**Post date:** [March 28, 2018, 3:25am UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/11 "2018-03-28T03:25:52Z")

</div>

Just an update on this:

Wiki.js 2.0 is estimated to be released in Q2, currently the auth system is finished, so I’m going to start making a Discourse auth module.

As 2.0 becomes more feature-complete I’ll get a copy up to begin the migration.

---

<div class="post-metadata">

**Author:** ![Cameron\_D](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/cameron_d/32/251_2.png) [@Cameron\_D](https://forums.sourceruns.org/u/Cameron_D)\
**Post date:** [April 23, 2018, 11:21am UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/12 "2018-04-23T11:21:24Z")

</div>

I have a copy of wikijs running now. If you’d like access to begin writing pages let me know here or over Discord and I’ll set you up (Or you [can write Markdown pages directly](https://git.sourceruns.org/wiki/wiki) if that’s your style)

---

<div class="post-metadata">

**Author:** ![Cameron\_D](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/cameron_d/32/251_2.png) [@Cameron\_D](https://forums.sourceruns.org/u/Cameron_D)\
**Post date:** [May 29, 2018, 11:15am UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/13 "2018-05-29T11:15:59Z")

</div>

Popping this in here for future reference. At this point I think its best to go with a single page separate sections for each engine for each trick.

> [@](#):
>
> **Cameron:D:** @executλble RE wiki: I think the best way is still to keep one page per trick and just have a different section for execution on the different engines, like the current bhop page  
> **Cameron:D:** [https://wjs.sourceruns.org/bunny-hopping](https://wjs.sourceruns.org/bunny-hopping)  
> **executλble:** the main problem is navigation  
> **Cameron:D:** Maybe the paragraph on OB engine should be moved to its own section  
> **executλble:** you have to categorize the tricks somehow and bunnyhop being one in pretty much all games makes it tricky to decide where exactly to put it  
> **mike:** you don’t actually have to categorise everything  
> **Cameron:D:** The current wiki has the category pages [Category:Half-Life 1 - SourceRuns Wiki](https://wiki.sourceruns.org/wiki/Category:Half-Life_1) that list all the applicable tricks for each game,y idea was to turn those into a bit of a list of all the info on each game  
> **mike:** wait what about categorising by the actual type of trick  
> **Cameron:D:** So the hl1 index would link to the hl1 section on the bhop page(edited)  
> **mike:** faster movement, fall cancelling, teleportation, clipping/oob, etc etc  
> **executλble:** yea I was thinking about that mike  
> **executλble:** putting it under “movement glitches” or somethingexecutλble: but then the problem is if a newcomer is browsing the wiki looking to learn some tricks, hard to figure out what is for goldsrc and what is for source and so on(edited)  
> **executλble:** probably not a realistic scenario but idk  
> **executλble:** an index page would work I guess(edited)  
> **executλble:** but I feel there’s a better way to do it  
> **executλble:** and still gotta categorize somehow  
> **Cameron:D:** From what I can tell, most of the wiki traffic is people after info on a specific thing, rather than people looking for info on getting started  
> **Cameron:D:** Though part of that is probably because there isn’t much in the way of recent guides there  
> **executλble:** at the moment I think being arbitrary with the categories is the most user-friendly way  
> **executλble:** I mean the categories being “Half-Life 1 & expansions”, “Half-Life 2 and episodes”, “Portal”, “Portal 2” and so on(edited)  
> **executλble:** if there was an easy way to link to same page in different paths (within wjs, without the use of nginx preferably) then it could be done  
> **executλble:** for tricks that are the same across all the games  
> **executλble:** and then the ones that are different but have the same name like Bunnyhopping, you could just have individual pages for each, I don’t see a problem with that since the content differs anyway(edited)  
> **executλble:** and the page would only focus on those certain applications rather than trying to cover everything  
> **Cameron:D:** The problem is that if people do a google search for bunny hopping, it may not land them on the right page  
> **Cameron:D:** Which would be more confusing that having per-game sections on one page, I think(edited)  
> **executλble:** oh that’s a good point  
> **executλble:** unless we name the pages like “goldsrc bunnyhopping”  
> **executλble:** but nah that will look stupid

And something else…  
[https://twitter.com/requarks/status/1001248793050976256](https://twitter.com/requarks/status/1001248793050976256)  
Should be able to get to migrating Russian pages soon.

---

<div class="post-metadata">

**Author:** ![Pashok11](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/pashok11/32/81_2.png) [@Pashok11](https://forums.sourceruns.org/u/Pashok11)\
**Post date:** [January 24, 2021, 4:59pm UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/14 "2021-01-24T16:59:35Z")

</div>

Where is the new wiki?

---

<div class="post-metadata">

**Author:** ![Centaurium](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/centaurium/32/206_2.png) [@Centaurium](https://forums.sourceruns.org/u/Centaurium)\
**Post date:** [January 27, 2021, 9:16pm UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/15 "2021-01-27T21:16:21Z")

</div>

Non-existent. No one really wants to work on this, and thus it didn’t get done. I think the wiki was great in a time before Discord, but now everyone gets their info from the server.

---

<div class="post-metadata">

**Author:** ![Cameron\_D](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/cameron_d/32/251_2.png) [@Cameron\_D](https://forums.sourceruns.org/u/Cameron_D)\
**Post date:** [February 7, 2021, 6:25am UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/16 "2021-02-07T06:25:01Z")

</div>

> [@Centaurium](#):
>
> No one really wants to work on this, and thus it didn’t get done

Pretty much that. I was happy to put in the work to get a new modern wiki up but couldn’t migrate and fill in the info because I simply don’t know enough anymore.

> [@Centaurium](#):
>
> I think the wiki was great in a time before Discord, but now everyone gets their info from the server.

Not quite, the wiki still sees over 12,000 visitors a month from Google (+more from other places too, though analytics has been broken so not entirely sure how many more at the moment), so thats still quite a lot of people referring to the info there.

---

<div class="post-metadata">

**Author:** ![Centaurium](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/centaurium/32/206_2.png) [@Centaurium](https://forums.sourceruns.org/u/Centaurium)\
**Post date:** [February 26, 2021, 12:00pm UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/17 "2021-02-26T12:00:41Z")

</div>

> [@Cameron\_D](#):
>
> Not quite, the wiki still sees over 12,000 visitors a month from Google (+more from other places too, though analytics has been broken so not entirely sure how many more at the moment), so thats still quite a lot of people referring to the info there.

Oh, hmm. Might be worth investing time into, then.

---

<div class="post-metadata">

**Author:** ![Felix\_Tremblay](https://b-cdn.sourceruns.org/user_avatar/forums.sourceruns.org/felix_tremblay/32/1523_2.png) [@Felix\_Tremblay](https://forums.sourceruns.org/u/Felix_Tremblay)\
**Post date:** [February 16, 2025, 9:25am UTC](https://forums.sourceruns.org/t/wiki-overhaul/3003/20 "2025-02-16T09:25:52Z")

</div>

the new wiki is wiki.openag.pro and it does exist
