Jump to content

The Wiki. What Wiki? Exactly.


Akkarin

Recommended Posts


  • Group:  Forum Manager
  • Topic Count:  282
  • Topics Per Day:  0.06
  • Content Count:  3122
  • Reputation:   1614
  • Joined:  03/26/12
  • Last Seen:  

Afternoon everyone!

Many moons ago we migrated our wiki content to Github in an effort to alleviate resources on our VM, increase our data's stability and in-general, significantly reduce the number of things that could go wrong. That was the plan.

The plan worked well enough on all three counts above, however, Github Wiki's have this wonderful knack of not doing what they're supposed to when you need them to be helpful. For example, users needing special permissions to push new content to it (until very recently this has been "maintainer" access only), which means everyone has to rely on rA Staff to update the Wiki, which we evidently haven't had much time for.

Now there's a new kid on the block; User-Guides!

Guides from the Wiki will slowly be migrated to our new User Guides site (which you can help with, if you want to), which is a HTML website hosted using Github Pages, automatically generated from Markdown files that are stored in a Github Repository. Neat, huh! View the site at https://rathena.github.io/user-guides/

Because this new guide platform is built on a git repo, it means that anyone can contribute to it by opening a Pull Request. I've written some guidance here: https://github.com/rathena/user-guides/blob/master/CONTRIBUTING.md

"What about all those guides on the forums" I hear you ask. Let's face it, 20% of them don't make any sense, 30% of them are inaccurate, 90% of them are outdated, 100% of them are developed with either bias towards specific software tools or just badly written due to language barriers or laziness. Far too often are links to out-of-date guides re-posted on the forums and in Discord, and we can't keep them updated because they're forum posts so only Mods can edit them (which is not what they're here for).

From now on, well-written guides are to be posted to the User Guides repo. Guides posted on these forums will result in a message being sent to the author stating why we're going to hide the thread and then give a link to this post.

What can you NOT post to User Guides?

rAthena is a software emulation project. As such, guides pertaining to 3rd Party Tools or software will not be approved. This includes "How-To's" regarding the client, which is not actually within the scope of the rAthena project. We don't want to be sued ?, thanks.

We have a new channel in Discord called #user-guides for discussions related to this area of the project. We would be very happy to see you helping our effort to migrate and write good, informative guides for our community to use and keep updated for years to come!

Next we'll be working on doing something very similar to our source's /doc/ directory!

Akky~

  • Upvote 5
  • MVP 2
Link to comment
Share on other sites

  • 1 month later...

  • Group:  Members
  • Topic Count:  2
  • Topics Per Day:  0.00
  • Content Count:  8
  • Reputation:   6
  • Joined:  06/15/21
  • Last Seen:  

How about adding some information or context about this migration in the old wiki or the README.md file of the new user guide repo?
So new visitors know that guides from the Wiki will slowly be migrated to our new User Guides site.

Link to comment
Share on other sites

Guest
This topic is now closed to further replies.
×
×
  • Create New...