alliedmodders / amxmodx

AMX Mod X - Half-Life 1 Scripting and Administration
http://www.amxmodx.org/
499 stars 203 forks source link

[Wiki] Wiki is not being maintained #996

Closed ShootingKing-AM closed 3 years ago

ShootingKing-AM commented 3 years ago

There is valuable info in wiki.alliedmods.net/Amxmodx, but its not being updated since the core team is busy with someother things. Why not move to github-wiki/github-pages ?

Github-Pages have the following benefits,

Furthur Github-Pages have some limitations, which most probably wont be hit.

GitHub Pages sites are subject to the following usage limits:

  • GitHub Pages source repositories have a recommended limit of 1GB. For more information, see "What is my disk quota?"
  • Published GitHub Pages sites may be no larger than 1 GB.
  • GitHub Pages sites have a soft bandwidth limit of 100GB per month.
  • GitHub Pages sites have a soft limit of 10 builds per hour.
dvander commented 3 years ago

Anyone can maintain the wiki. It's a wiki. Just log in with a forum account and start editing. The reason no one maintains it is not because it's not on GitHub. It's because writing documentation is not fun for most people.

ShootingKing-AM commented 3 years ago

Sorry, but i feel that its unfair to say people do not wish to write/update documentation :( Infact, Many of the PRs here are related to Documentation in .inc(s). Even, Code/Snippnets/Tutorials Section of Amxmodx Forums is also active till date. Github forces Repo Owners/Maintainers to give credit to contributors even if the software inheriently dosent. Also the reason why, the Wiki is only updated by 2-3 official team members and code base on github has 50 odd non-official contributors.

I think, if amxmodx is to be sustainable, we have to make it easier for people to contribute.

dvander commented 3 years ago

I'm not sure what that means. It's very easy to contribute. Log in with a forum account and start editing.

dvander commented 3 years ago

One other thought - I'm not opposed to GH wiki, since it's just a repo of markdown docs, and changes would need review (currently our wiki has no review policy). I think for new projects the markdown approach is great.

But... who is going to do the work of porting all the AMXX docs over, including any translations and attached media? It's a huge task even if automated tools exist. If someone is offering to do that task we can chat.

ShootingKing-AM commented 3 years ago

But... who is going to do the work of porting all the AMXX docs over, including any translations and attached media? It's a huge task even if automated tools exist. If someone is offering to do that task we can chat.

There are tools to convert mediaWiki to markdown Eg. This and This. We can atleast try and I dont think its hard.

dvander commented 3 years ago

Sure, you're welcome to give it a try. It looks like anyone can do it.