Akkarin

Wiki Moved to Github!

Recommended Posts

Hey guys!

 

Our Wiki is moving to Github.

 

Actually, it's already there, but the conversion process isn't perfect. Some of the links and headers from the older Mediawiki syntax remain, which means the pages look a little bit messy. The current wiki hosted by us is in read-only mode.

 

This is where you can help!

 

There are currently over 700 pages that require attention. Do you have a spare half hour to give us a hand?

 

What we need:

  • Links changing to pages that exist.
    • Pages can now have spaces in the links, which equates to a dash (-) in the title. For example [Database Configuration](Database-Configuration) and will be our new naming convention.
    • If the page doesn't exist, you may be able to find it by using the search bar on the right of the wiki homepage.
  • Formatting
    • Section headers need to be addressed
    • Code needs correct indentation for formatted output (4 spaces)
  • Content correction
    • Some of the pages are years old and the functions/script they're describing either no longer functions that way, or doesn't exist.

We have setup a special Wiki-Editing group on Github, so all you need is an account and you can make a start! Don't worry about making a mistake, there is a "Preview" option to double check, and everything is revision controlled so major hiccups can be reverted :)

 

This is a mammoth task. We fully understand that. To help, we will be using the https://rathena.org/board/forum/63-rathena-wiki-discussion/ forum to discuss and assign larger pages to the Wiki team. 

  • Upvote 1

Share this post


Link to post
Share on other sites

[spoiler=normal user, comments]awesome

 

[spoiler=my comment]good luck with those 700 pages /heh

Share this post


Link to post
Share on other sites

700 pages, and around 80% of these pages are just copy-paste from script commands. Anyway, i wish to say thank you very much for that changes, it will be very improved in very soon time!

Share this post


Link to post
Share on other sites

around 80% of these pages are just copy-paste from script commands

 

That's correct. We don't need all of these copy-paste pages, or if we're keeping them then we should atleast expand on them all with proper examples in working code. Or we just ditch them :/

Share this post


Link to post
Share on other sites

 

around 80% of these pages are just copy-paste from script commands

 

That's correct. We don't need all of these copy-paste pages, or if we're keeping them then we should atleast expand on them all with proper examples in working code. Or we just ditch them :/

 

which one faster, ditch then re-parse from script_commands.txt or 'do some magic to' use that copy-paste pages?

Share this post


Link to post
Share on other sites

Fixing the old internal wiki links:

git clone https://github.com/rathena/rathena.wiki.git wiki; cd wiki
find ./ -type f -iname "*.md" -exec sed -i -E "s|\(/([^\)]+)\s\"wikilink\"\)|\(\1\)|" {} \;
#git push

You can already test it here (this is not the original rathena wiki):

https://github.com/Jeybla/rathena/wiki

 

Optionally you can use the last commit in https://github.com/Jeybla/rathena.wiki.git :

 

If you like to, I'd parse some doc infos or write a small helper bot to do so.

 

Edit:

Just want to mention here, that I cannot edit any page directly ;_;

 

And we need to replace all category links with new category pages.

Edited by Jey

Share this post


Link to post
Share on other sites

Fixing the old internal wiki links:

git clone https://github.com/rathena/rathena.wiki.git wiki; cd wiki
find ./ -type f -iname "*.md" -exec sed -i -E "s|\(/([^\)]+)\s\"wikilink\"\)|\(\1\)|" {} \;
#git push

You can already test it here (this is not the original rathena wiki):

https://github.com/Jeybla/rathena/wiki

 

Optionally you can use the last commit in https://github.com/Jeybla/rathena.wiki.git :

 

If you like to, I'd parse some doc infos or write a small helper bot to do so.

 

Edit:

Just want to mention here, that I cannot edit any page directly ;_;

 

And we need to replace all category links with new category pages.

 

Jey, while your script looks useful, it serves no purpose in our repo as the links would still point to content that no longer exists.

 

It also states in the first post that there is a special editing group.

Share this post


Link to post
Share on other sites

Example:

In https://github.com/rathena/rathena/wiki/scripting is a link to " Adding a Script". It refers to this (wrong) page: https://github.com/Adding_a_Script

 

But should link to this page: https://github.com/rathena/rathena/wiki/Adding_a_Script

That's what fixes my small script. And there are many of those links.

Edited by Jey

Share this post


Link to post
Share on other sites

To be titled correctly, that particular page would become /Adding-A-Script. I see what you're trying to do, but each page would still require manually going over to remove links to Script Command pages, formatting, correct indentation, etc.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now