{"id":120,"date":"2010-01-04T17:29:44","date_gmt":"2010-01-04T17:29:44","guid":{"rendered":"http:\/\/lydgate.org\/blogs\/?p=120"},"modified":"2010-01-04T17:29:44","modified_gmt":"2010-01-04T17:29:44","slug":"documentation-for-all","status":"publish","type":"post","link":"http:\/\/lydgate.org\/blogs\/2010\/01\/documentation-for-all\/","title":{"rendered":"Documentation for all"},"content":{"rendered":"<p>A wiki is supposed to be an easy place for all to contribute to documentation, but when we held an IRC meeting about UserBase, back in October, it was clear that not everyone found the wikis welcoming or comfortable.\u00a0 We&#8217;ve started several initiatives to solve, or at least alleviate, some of the problems.<\/p>\n<h1><strong>Getting Started<\/strong><\/h1>\n<p>First, we have made sure that &#8216;Help&#8217; in the navigation panel\u00a0 points to http:\/\/userbase.kde.org\/Help:Contents &#8211; where general guidance is found.\u00a0 Then, right at the bottom of the page is a Category link.\u00a0 Clicking on that takes you to a page that lists other pages that you might find helpful &#8211; some to help you quickly find what you need, and others to help you get started contributing.\u00a0 At the moment the English pages are, I believe, fully represented.\u00a0 Currently you will see some translated pages listed there, but work is in hand to improve this, giving languages their own Category links.\u00a0 Watch this space!<\/p>\n<h1><strong>Getting Help<\/strong><\/h1>\n<p>So &#8211; you&#8217;ve found your way around a bit, and know roughly what you want to say, but you&#8217;re still finding the whole thing a bit daunting.\u00a0 Well, the first thing is to remember that you are not working in a vacuum.\u00a0 Sign on to #kde-www on irc.freenode.org and there will always be someone around to help.\u00a0 Even better &#8211; starting next weekend we have a Klassroom course on contributing to UserBase.\u00a0 Sign on at<a title=\"this forum page\" href=\"http:\/\/forum.kde.org\/viewtopic.php?f=4&amp;t=84864.\"> http:\/\/forum.kde.org\/viewtopic.php?f=4&amp;t=84864.<\/a><\/p>\n<h1><strong>Tell me about the course?<\/strong><\/h1>\n<p>The aim is quite simple &#8211; to make you familiar and comfortable with the tools of mediawiki editing and the layout of a typical UserBase page.\u00a0 This course is for you if<\/p>\n<ul>\n<li>You are a user without development skills and want to make your contribution by helping others to enjoy KDE software<\/li>\n<li>An application that you use frequently has little, or outdated, documentation on userbase, and you know you could help people get more out of it.<\/li>\n<li>You are a developer, and your application is under-represented, or not represented on UserBase.<\/li>\n<li>You are a developer and have documentation elsewhere but want an easier place to work with it.<\/li>\n<\/ul>\n<p>You will work on a UserBase page, asking questions on a dedicated forum thread.\u00a0 You will see questions asked and answers received by other students.\u00a0 You will do the work at times when it suits you.\u00a0 Help pages have been prepared to give you all the tools you are likely to need.\u00a0 In fact, the aim is to make it as un-threatening as possible.<\/p>\n<h1><strong>Sign up<\/strong><\/h1>\n<p>This week is sign-up time.\u00a0 We look forward to seeing you on <a title=\"the forum page\" href=\"http:\/\/forum.kde.org\/viewtopic.php?f=4&amp;t=84864.\">http:\/\/forum.kde.org\/viewtopic.php?f=4&amp;t=84864<\/a> or come along to #kde-www to ask questions.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>I&#8217;d like to contribute, but I don&#8217;t program, and writing documentation is just too hard &#8211; or is it?<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[14,6],"class_list":["post-120","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-kde","tag-userbase"],"_links":{"self":[{"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/posts\/120","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/comments?post=120"}],"version-history":[{"count":5,"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/posts\/120\/revisions"}],"predecessor-version":[{"id":125,"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/posts\/120\/revisions\/125"}],"wp:attachment":[{"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/media?parent=120"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/categories?post=120"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/tags?post=120"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}