{"action":"created","issue":{"url":"https://api.github.com/repos/voidlinux/void-packages/issues/4961","repository_url":"https://api.github.com/repos/voidlinux/void-packages","labels_url":"https://api.github.com/repos/voidlinux/void-packages/issues/4961/labels{/name}","comments_url":"https://api.github.com/repos/voidlinux/void-packages/issues/4961/comments","events_url":"https://api.github.com/repos/voidlinux/void-packages/issues/4961/events","html_url":"https://github.com/voidlinux/void-packages/issues/4961","id":182908794,"number":4961,"title":"Our wiki slowly dies and turns into garbage","user":{"login":"skrzyp","id":555587,"avatar_url":"https://avatars.githubusercontent.com/u/555587?v=3","gravatar_id":"","url":"https://api.github.com/users/skrzyp","html_url":"https://github.com/skrzyp","followers_url":"https://api.github.com/users/skrzyp/followers","following_url":"https://api.github.com/users/skrzyp/following{/other_user}","gists_url":"https://api.github.com/users/skrzyp/gists{/gist_id}","starred_url":"https://api.github.com/users/skrzyp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/skrzyp/subscriptions","organizations_url":"https://api.github.com/users/skrzyp/orgs","repos_url":"https://api.github.com/users/skrzyp/repos","events_url":"https://api.github.com/users/skrzyp/events{/privacy}","received_events_url":"https://api.github.com/users/skrzyp/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":8,"created_at":"2016-10-13T21:38:31Z","updated_at":"2016-10-13T23:43:19Z","closed_at":null,"body":"# Good evening everyone, did you know that we have a running MediaWiki instance?\r\n\r\n### What the…? \r\nWhile that was discussed on IRC before, I would like to get more people noticed on this. For those who don't know yet, we have a wiki. It's hosted at http://wiki.voidlinux.eu/ and there was [almost no major edits in last months](https://wiki.voidlinux.eu/index.php?namespace=0&hideminor=1&days=365&limit=5000&title=Special%3ARecentChanges) except **massive spam** from mediawiki-enabled bots. \r\n\r\nCurrently, wiki has only about ~100 articles, while at least 10% are a copy-paste from ArchWiki (mentioned inside or not). Lots of articles are outdated, irrelevant to Void directly or can be merged into larger ones (like those about installing Void). As there are no active maintainers for wiki, all of those articles are getting rust (not in sense of language) while Void Linux project grows each day.\r\n\r\nAlso **articles under \"usage\" namespace are hosted outside of wiki** ([runit](http://www.voidlinux.eu/usage/runit/) is an example) and probably duplicating content inside wiki. There are also various markdown files with valuable docummentation bits in our repos, but not many people got there. And of course we have manpages too, but it's better not to touch them.\r\n\r\n### The vision\r\nIf the time allows, I'm going to (re)create the central directory of Void-related docummentation. While it sounds big and like marketing buzzword, I see it just like little tree of (Pandoc) Markdown files, divided onto 3 \"spaces\"\r\n\r\n- **void** - Docs related to Void Linux and XBPS directly, unusable under other cases\r\n  - **examples**: `installation-guide.md`,  `xbps.md`, `xbps-src.md`\r\n- **general** - Mostly general docs about things abailable in Void, much like ArchWiki, but instead of general usage instructions (where we can just post URLs to official docs at the top) we can focus on setting up those things in Void, or issues resulting from our philosophy/architecture\r\n  - **examples**: `steam.md`, `runit.md`, `plan9.md`, `musl.md`\r\n- **guides**: Turn-key solutions as complete how-to guides, probably the most controversal namespace: kids will love them, contributors will hate them. I was inspired from Alpine wiki where they have separated category for \"how to do X with Alpine and make people happy\". Of course instead of turn-by-turn howto I'd like to show the core value of certain piece of software with bunch of examples and many additional informatios, but without losing the topic.\r\n  - **examples**: `howto-lighttpd.md`, `howto-xfce.md`, `howto-logging.md`\r\n\r\nI was also considering fourth \"space\" for some formal/organization documents related to contribution or internal use, but I think they might safely land into \"void\".\r\nWhen the particular topic will be created, I think we might cover it from A to Z, or as much as it needs to be. I don't want to clutter docs and annoy people with 5 different pages about the same thing on different platforms or cases.\r\n\r\n### The technology\r\nAs I mentioned before, (Pandoc) Markdown would be the weapon of choice. And while raw `.md` files would be enough, I think we need some presentation of them on Web. And that's not really hard or complex, because we only need text (and images). No bells and whistles, so static website generator should suffice. And it can be just simple as that\r\n````sh\r\nfor i in docs/*.md ; do\r\n  _temp=$(mktemp)\r\n  cat common/header.html >> $_temp\r\n  pandoc -t html5 -f markdown $i >> $_temp\r\n  cat common/footer.html >> $_temp\r\n  mv $_temp > html/$i.html\r\ndone\r\n# of course it's a PoC, please don't hate this shitty piece of code!\r\n# it lacks many things like generating ToC or being a proper git hook\r\n````\r\nSo, keeping this simple as possible, and does not really require running additional CGI nodes or something\r\n\r\n### The risks\r\nAs everybody knows, life is brutal and even that little project may fail. Right now I can list 3 of them straight from my head:\r\n- **lack of my time**: While I'm really attached to Void since end of 2013 and I actually want to bring something good in this community, my time schedule is randomly varying from \"empty\" to \"busy as hell\" states. One of this might came while I change my current job soon, but that's not 100% sure and it might result in completely different thing, while I could give you more good. But one can tell I'm lying about that while I vanish for the next 2 months.\r\n- **lack of your interest**: Many of you can just look and this and think \"leave this at it is, nobody's harmed\" or stop doing anything after first \"thumb-up\" comment or even actual commit. That's a continous project which requires (not so much, but still) regular work.\r\n- **lack of language skill**: From this text people can figure out my English sucks so bad, as it's not my first and native language. This is a huge issue when it goes to write serious documents which will be read by many of you. In this case, we need people being supportive as correction or even full-blown *\"grammar nazi\"*\r\n\r\n### I need your voice\r\nThank you for reaching this part, now it's time for your feedback.\r\nI'm completely open for changes to *any* of previous statements, additional suggestions and corrections. Don't hestiate to write anything, even ranting that concept would be appreciated, because that means this text actually involved you to do anything.\r\n\r\n**And no, leaving *\"+1\"* is not a sign of anything, just looks as \"lol nice but ima lazy\".** :)"},"comment":{"url":"https://api.github.com/repos/voidlinux/void-packages/issues/comments/253671441","html_url":"https://github.com/voidlinux/void-packages/issues/4961#issuecomment-253671441","issue_url":"https://api.github.com/repos/voidlinux/void-packages/issues/4961","id":253671441,"user":{"login":"Vaelatern","id":7906072,"avatar_url":"https://avatars.githubusercontent.com/u/7906072?v=3","gravatar_id":"","url":"https://api.github.com/users/Vaelatern","html_url":"https://github.com/Vaelatern","followers_url":"https://api.github.com/users/Vaelatern/followers","following_url":"https://api.github.com/users/Vaelatern/following{/other_user}","gists_url":"https://api.github.com/users/Vaelatern/gists{/gist_id}","starred_url":"https://api.github.com/users/Vaelatern/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Vaelatern/subscriptions","organizations_url":"https://api.github.com/users/Vaelatern/orgs","repos_url":"https://api.github.com/users/Vaelatern/repos","events_url":"https://api.github.com/users/Vaelatern/events{/privacy}","received_events_url":"https://api.github.com/users/Vaelatern/received_events","type":"User","site_admin":false},"created_at":"2016-10-13T23:43:19Z","updated_at":"2016-10-13T23:43:19Z","body":"Not really a problem. So long as the docs can be adjusted (or have edits changed) by someone wishing to contribute (perhaps a \"Submit edits here\" link on each page), it should be relatively simple to keep this up to date."}}
{"actor":{"display_login":"Vaelatern"}}