Jump to content
Jguy

Forum side MediaWiki being moved to GitHub!

Recommended Posts

Dear community,
 
Our wiki is our lifeline when it comes to documentation. There is no easier way to write documentation to be read and changed by all then to have it centralized to one place and easily linked through to places it needs to be linked.
 
However, the current installation of MediaWiki we have is poor at doing its job for the most part. It's largely non-maintained and is hindering our IPB side progression as everything we do with the forum has to be compatible with our IPBWiki version, which is terribly outdated (with no more updates to it available) and is preventing us from installing automatically some updates to our IPB installation, or even upgrading our forums (we can't make the switch to IPB 4 because of the MediaWiki installation, for example).
 
Therefore, effective immediately, the current installation of MediaWiki, located here, will immediately be set to read-only, and we will be moving most of the information to our GitHub HerculesWS account, which has Wiki support, located here: https://github.com/HerculesWS/Hercules/wiki

 

Such integration with our GitHub account will allow us multiple advantages, including:

 

* Cloning a local copy of the wiki to your desktop using git, which we already do for our repository

* Making changes locally and pushing those changes back to the wiki, all offline.

* Support markdown, RST and Textile, among others.

* Easily reference bits or blocks of code and link back and forth between the wiki, a commit, issue, a file or pull request, if we want.

 

With this, we can also make a push to upgrade our out of date IPB installation easier, and cut ties to things that are holding us back from a community standpoint. This also affords us the opportunity to sort through our documentation and write things that really matter, in a clear and concise way.

 

The timeline for the move will hopefully be done in the next couple of weeks, "automagically". Note that the current mediawiki is still readable, except nothing can be changed any longer.

 

Please let us know if you have any questions, comments or concerns with this change.

Share this post


Link to post
Share on other sites

Some of you may now notice that navigation at the top of our forums has been changed to direct you to the new wiki and archived one. As Jguy has already mentioned, the old Wiki has been set as read-only for members; however, staff are still able to make changes like redirecting the content to the new destination on the new wiki. 

Share this post


Link to post
Share on other sites

On the topic of migrating documentation, I'm curious if the Doxygen pages can be put into Githhub as well... hmmmm.

Share this post


Link to post
Share on other sites

So we are no longer able to edit the old wiki, and:

 

 

 1. Do not create pages or guides for custom content. Base client specific
content is OK, as this is the main point behind Hercules. However, leave
patchers, custom patches or plugins, setup of custom items or mobs, or
control panels out.

 

So where are we moving the custom guides to?

Share this post


Link to post
Share on other sites

So we are no longer able to edit the old wiki, and:

 

 

 1. Do not create pages or guides for custom content. Base client specific

content is OK, as this is the main point behind Hercules. However, leave

patchers, custom patches or plugins, setup of custom items or mobs, or

control panels out.

 

So where are we moving the custom guides to?

 

This excerpt in the "new" wiki was not refined enough, as it is ever changing content. It was intended to be "don't make content related to the actual creation or use of the custom content".

 

Examples:

 

* Addition of custom mobs into the emulator - OK

* Addition of custom mobs into the client - OK

* Creation of the actual custom mob (spriting, behavior, etc) - Not OK

* Addition of a custom map into the emulator - OK

* Addition of a custom map into the client - OK

* How to use BrowEdit - Not OK

 

The problem with including client side content into the GitHub wiki, from what I understand regarding how anal GitHub can be, is that the more client side potentially copyrighted stuff we include, the more possible it'll be the HerculesWS GitHub project could get shut down because of licensing issues.

Share this post


Link to post
Share on other sites

Gotcha! Makes a lot more sense. :)

 

Edit: Although on the mob spriting, I imagine so long as it is entirely created from scratch, not just an edit or recolor, copyright shouldn't be able to pursue that, but I can understand the mob behavior, I do believe that is a G-specific thing.

Edited by Wolfeh

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Loading...

×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use.