Help:Contribute: Difference between revisions

Latest revision as of 12:35, 9 February 2018

Other languages:

This page contains information about editing the KDE TechBase wiki, including what content belongs where and helpful tools specific to this wiki. Even if you are familiar with wikis, you should read the section on organisation to see what content should be put where on this wiki.

Before you Start

First Things First

To contribute to TechBase you must register an account with the KDE Identity service, then activate it on Phabricator by logging in there, and then you can click the Login with Phabricator link on the sidebar to log in.

Be aware that you must agree to your contributions to this wiki being released under the licenses listed at KDE TechBase:Copyrights. These licenses mean that what you write might be copied to other sites, for example.

Use the Talk pages to communicate with other contributors or get help. Normally someone will get back to you within a day.

Relevance

This wiki is for documentation for developers wanting to use or extend KDE products (e.g. via APIs), or:

overview information for libraries, including the advantages of using them
tutorials and examples for using libraries
tutorials, examples and documentation for writing plugins and other extensions to libraries and applications
IPC/RPC interfaces for software, like DBus interfaces

End-user documentation belongs on UserBase, and things directed at contributors, teams and the KDE Community in general belong on the community wiki.

Examples of things that don't belong on TechBase include:

documentation on how to use an application
code style policies
information for new contributors
team coordination (TODO lists, meeting notes, etc)
notes on the internal architecture of a piece of software (but the architecture of a library's API does belong)

More on this on the guidelines on community.kde.org

Organisation

noframe

TODO
need to document the structure

Formatting

The main MediaWiki site has a Wiki syntax guide
UserBase has some lists of formatting that can be a useful reference, including templates that are specific to the KDE wikis.
Much of what applies to Wikipedia (except the templates) also applies here, including Wiki markup and their cheatsheet.

Wiki Maintenance

Maintaining a clean and useful wiki involves making sure content is up to date, there are no broken links, and all pages can be found (they are linked to from somewhere). The following special pages can help find issues that need fixing:

Issues which should be fixed as soon as possible: Special:Lonelypages; Special:BrokenRedirects; Special:DoubleRedirects

Issues which should be fixed in time: Special:Wantedpages; Special:Wantedcategories

You can also add a page to the Needs Attention to flag it for later work by adding [[Category:Needs Attention]] to the page. Using Template:TODO will also add a page to this category.

Deleting pages

Most users cannot delete pages on the Wiki - this is because once a page is gone, you cannot get it back. If you think a page should be deleted, mark it with Template:Proposed_deletion at the top:

{{Proposed_deletion|reason=this page contains only spam}}

@@ Line 1: / Line 1: @@
-You are welcome to contribute to the KDE TechBase wiki. In order to keep a high quality of the articles there are some guidelines you should follow.
+<languages/>
-== What Content belongs into KDE TechBase ==
+<translate><!--T:1-->
+This page contains information about editing the KDE TechBase wiki, including what content belongs where and helpful tools specific to this wiki. Even if you are familiar with wikis, you should read [[#Organisation|the section on organisation]] to see what content should be put where on this wiki.
-The KDE TechBase wiki is meant to contain technical information all around KDE, for instance
+==Before you Start== <!--T:2-->
-* Developer Information (e.g. [[Development/Tutorials|tutorials]])
-* documentation for [[SysAdmin|System Administrator]]
-* policies and schedules
-* etc.
-More details can be found in the article [[Help:Wiki Structure]]. [http://docs.kde.org End-user documentation] or [http://api.kde.org API documentation] should ''not'' be added here. For non-technical use cases use the [http://wiki.kde.org KDE wiki].
+===First Things First=== <!--T:3-->
-== Where to put new Articles ==
+<!--T:4-->
+* To contribute to TechBase you must register an account with the [https://identity.kde.org KDE Identity service], then activate it on [https://phabricator.kde.org Phabricator] by logging in there, and then you can click the [[Special:PhabricatorLogin/redirect|Login with Phabricator]] link on the sidebar to log in.
-The KDE TechBase wiki uses subpages. Take a quick look at the article about the [[Help:Wiki Structure]]. In short: Do not randomly add toplevel pages.
+<!--T:5-->
+* Be aware that you must agree to your contributions to this wiki being released under the licenses listed at [[KDE TechBase:Copyrights]]. These licenses mean that what you write might be copied to other sites, for example.
-It is possible to translate KDE TechBase articles into other languages. Read the article about [[Help:Wiki Translation]] for further details.
+<!--T:6-->
+* Use the [https://www.mediawiki.org/wiki/Help:Talk_pages Talk pages] to communicate with other contributors or get help.  Normally someone will get back to you within a day.
-== The Procedure ==
+===Relevance=== <!--T:7-->
-You want to add new content. To keep high quality, please create the article in your userpage first (e.g. User:foo/My Acticle). Once it is ready, discuss the article with other developers and proof-read it. Finally, if a location is found, move the page.
+<!--T:8-->
+This wiki is for documentation for developers wanting to use or extend KDE products (e.g. via APIs), or:
-After moving the page please '''add yourself to the watch list''' by clicking the ''Watch'' register. You will get a notice by mail whenever the page changes.
+<!--T:9-->
+* overview information for libraries, including the advantages of using them
+* tutorials and examples for using libraries
+* tutorials, examples and documentation for writing plugins and other extensions to libraries and applications
+* IPC/RPC interfaces for software, like DBus interfaces
+<!--T:10-->
+End-user documentation belongs on [https://userbase.kde.org UserBase], and things directed at contributors, teams and the KDE Community in general belong on [https://community.kde.org the community wiki].
+<!--T:11-->
+Examples of things that '''don't''' belong on TechBase include:
+<!--T:12-->
+* documentation on how to use an application
+* code style policies
+* information for new contributors
+* team coordination (TODO lists, meeting notes, etc)
+* notes on the internal architecture of a piece of software (but the architecture of a library's API does belong)
+<!--T:13-->
+More on this on the [https://community.kde.org/Guidelines_and_HOWTOs/Documentation_in_wikis guidelines on community.kde.org]
+==Organisation== <!--T:14-->
+<!--T:15-->
+{{TODO|need to document the structure}}
+==Formatting== <!--T:16-->
+<!--T:17-->
+* The main MediaWiki site has [http://www.mediawiki.org/wiki/Help:Formatting a Wiki syntax guide]
+* UserBase has some [https://userbase.kde.org/Toolbox lists of formatting] that can be a useful reference, including templates that are specific to the KDE wikis.
+* Much of what applies to Wikipedia (except the templates) also applies here, including [http://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup] and their [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet cheatsheet].
+==Wiki Maintenance== <!--T:18-->
+<!--T:19-->
+Maintaining a clean and useful wiki involves making sure content is up to date, there are no broken links, and all pages can be found (they are linked to from somewhere). The following special pages can help find issues that need fixing:
+<!--T:20-->
+; Issues which should be fixed as soon as possible
+:[[Special:Lonelypages]]
+:[[Special:BrokenRedirects]]
+:[[Special:DoubleRedirects]]
+<!--T:21-->
+; Issues which should be fixed in time
+:[[Special:Wantedpages]]
+:[[Special:Wantedcategories]]
+<!--T:22-->
+You can also add a page to the [[:Category:Needs Attention|Needs Attention]] to flag it for later work by adding <nowiki>[[Category:Needs Attention]]</nowiki> to the page. Using [[Template:TODO]] will also add a page to this category.
+===Deleting pages=== <!--T:23-->
+<!--T:24-->
+Most users cannot delete pages on the Wiki - this is because once a page is gone, you cannot get it back. If you think a page should be deleted, mark it with [[Template:Proposed_deletion]] at the top:
+<!--T:25-->
+{{Input|1=<nowiki>{{Proposed_deletion|reason=this page contains only spam}}</nowiki>}}
+</translate>