Help:Contribute: Difference between revisions

From KDE TechBase
No edit summary
(Marked this version for translation)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>


<translate>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.
<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.


==Before you Start==
==Before you Start== <!--T:2-->


===First Things First===
===First Things First=== <!--T:3-->


<!--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.
* 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.


<!--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.
* 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.


<!--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.
* 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.


===Relevance===
===Relevance=== <!--T:7-->


This wiki is for documentation for developers wanting to use or extend KDE products. This includes:
<!--T:8-->
This wiki is for documentation for developers wanting to use or extend KDE products (e.g. via APIs), or:


<!--T:9-->
* overview information for libraries, including the advantages of using them
* overview information for libraries, including the advantages of using them
* tutorials and examples for using libraries
* tutorials and examples for using libraries
Line 22: Line 28:
* IPC/RPC interfaces for software, like DBus interfaces
* IPC/RPC interfaces for software, like DBus interfaces


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]. Examples of things that don't belong on TechBase include:


<!--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
* documentation on how to use an application
* code style policies
* code style policies
Line 30: Line 42:
* notes on the internal architecture of a piece of software (but the architecture of a library's API does belong)
* notes on the internal architecture of a piece of software (but the architecture of a library's API does belong)


==Organisation==
<!--T:13-->
 
More on this on the [https://community.kde.org/Guidelines_and_HOWTOs/Documentation_in_wikis guidelines on community.kde.org]
This wiki is organised using [https://www.mediawiki.org/wiki/Help:Subpages subpages]. This is a parent-child relation. For example, if we consider the [[Policies/Licensing Policy]] page, '''Policies''' is the ''parent'' of '''Licensing Policy''' and '''Licensing Policy''' is a ''subpage'' (or a child) of '''Policies'''.


This structure is useful because it provides a hierarchical organisation in the URL itself, makes page names less likely to clash (for example, many projects will want similarly-named pages) and provides back links (in the above example,  [[Policies/Licensing_Policy]] will contain a link back to [[Policies]] near the top).
==Organisation== <!--T:14-->


<!--T:15-->
{{TODO|need to document the structure}}
{{TODO|need to document the structure}}


==Formatting==
==Formatting== <!--T:16-->


<!--T:17-->
* The main MediaWiki site has [http://www.mediawiki.org/wiki/Help:Formatting a Wiki syntax guide]
* 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.
* 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].
* 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==
==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:
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
; Issues which should be fixed as soon as possible
:[[Special:Lonelypages]]
:[[Special:Lonelypages]]
Line 53: Line 68:
:[[Special:DoubleRedirects]]
:[[Special:DoubleRedirects]]


<!--T:21-->
; Issues which should be fixed in time
; Issues which should be fixed in time
:[[Special:Wantedpages]]
:[[Special:Wantedpages]]
:[[Special:Wantedcategories]]
:[[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.
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===
===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:
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>}}
{{Input|1=<nowiki>{{Proposed_deletion|reason=this page contains only spam}}</nowiki>}}
</translate>
</translate>

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

  • 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
noframe
 
TODO
need to document the structure

Formatting

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}}