Help:Contribute: Difference between revisions

From KDE Community Wiki
No edit summary
Line 1: Line 1:
You may find the following resources helpful:
<languages/>


* http://www.mediawiki.org/wiki/Help:Formatting
<translate>This page contains information about editing the KDE Community 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.
* http://en.wikipedia.org/wiki/Help:Wiki_markup
* http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet


==Before you Start==


=== Pretty gray formatting  ===
===First Things First===
The &lt;code> tag gives an ugly kind of yellow. To get a pleasant grey background, start a new line with a space in front of it. You can view the source to see how this works.


  <tt>myCodeSnippet();</tt>
* To contribute to Community 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.
 
* Be aware that you must agree to your contributions to KDE Community Wiki being released under the licenses listed at [[KDE Community Wiki:Copyrights]]. These licenses mean that what you write might be copied to other sites, for example.
 
* Use the Talk page to communicate with other contributors or get help. Normally someone will get back to you within a day.
 
===Relevance===
 
This wiki is for the KDE Community to coordinate and maintain information that is useful internally, as well as information useful for people who want to join the community. End-user documentation belongs on [https://userbase.kde.org UserBase] and documentation for developers wanting to use or extend KDE products (as opposed to those who want to contribute to them) belongs on [https://techbase.kde.org TechBase].
 
==Organisation==
 
This wiki is organised using [https://www.mediawiki.org/wiki/Help:Subpages subpages]. This means that a forward slash (/) in page names indicates that a page is a child of another page, much like how directories work on UNIX systems.
 
===Team pages===
 
Pages for teams to coordinate should go under a page for that team. For example, the main page for the team that works on KWin is at [[KWin]], and a page describing to new members how to get involved could be at [[KWin/Getting_Involved]].
 
The main team page should be linked from the [[Main_page|main page]]. Please carefully check that a page for your team does not already exist before adding it.
 
===Common pages===
 
Quite a bit of information is not team-specific, but is common to large parts (or all) of the community. Most of this will fit in one of the categories below, in which case it should go there. Otherwise, use your judgement (and don't be offended if it gets moved).
 
* [[Get Involved]] contains information for new contributors. Teams, particularly for software projects, may wish to have a "Get Involved" page in their own space as well.
* [[Policies]] contains rules that KDE projects and contributors are expected to follow
* [[Infrastructure]]] contains information on the infrastructure that KDE provides for its members and projects, such as Git hosting, collaboration tools (from mailing lists to patch review), bug reporting systems and so on.
* [[Guidelines_HOWTOs|Guidelines and how-tos]] contains helpful information for KDE projects, especially software projects, but (unlike Policies) KDE projects do not have to follow them. This includes recommendations on visual design, localisation and accessibility, for example, as well as help on how to do common tasks that are not specific to one team or project.
 
==Formatting==
 
* 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].
 
==Out of date and dead 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:
 
{{Input|1=<nowiki>{{Proposed_deletion|reason=this page contains only spam}}</nowiki>}}
 
If a page needs updating, but you aren't able to do that yourself, you can add it to the [[:Category:Needs Attention|Needs Attention]] category by adding <nowiki>[[Category:Needs Attention]]</nowiki> to the page.
</translate>

Revision as of 15:06, 10 March 2016

<languages/>

<translate>This page contains information about editing the KDE Community 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 KDE Community Wiki being released under the licenses listed at KDE Community Wiki:Copyrights. These licenses mean that what you write might be copied to other sites, for example.
  • Use the Talk page to communicate with other contributors or get help. Normally someone will get back to you within a day.

Relevance

This wiki is for the KDE Community to coordinate and maintain information that is useful internally, as well as information useful for people who want to join the community. End-user documentation belongs on UserBase and documentation for developers wanting to use or extend KDE products (as opposed to those who want to contribute to them) belongs on TechBase.

Organisation

This wiki is organised using subpages. This means that a forward slash (/) in page names indicates that a page is a child of another page, much like how directories work on UNIX systems.

Team pages

Pages for teams to coordinate should go under a page for that team. For example, the main page for the team that works on KWin is at KWin, and a page describing to new members how to get involved could be at KWin/Getting_Involved.

The main team page should be linked from the main page. Please carefully check that a page for your team does not already exist before adding it.

Common pages

Quite a bit of information is not team-specific, but is common to large parts (or all) of the community. Most of this will fit in one of the categories below, in which case it should go there. Otherwise, use your judgement (and don't be offended if it gets moved).

  • Get Involved contains information for new contributors. Teams, particularly for software projects, may wish to have a "Get Involved" page in their own space as well.
  • Policies contains rules that KDE projects and contributors are expected to follow
  • Infrastructure] contains information on the infrastructure that KDE provides for its members and projects, such as Git hosting, collaboration tools (from mailing lists to patch review), bug reporting systems and so on.
  • Guidelines and how-tos contains helpful information for KDE projects, especially software projects, but (unlike Policies) KDE projects do not have to follow them. This includes recommendations on visual design, localisation and accessibility, for example, as well as help on how to do common tasks that are not specific to one team or project.

Formatting

Out of date and dead 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}}

If a page needs updating, but you aren't able to do that yourself, you can add it to the Needs Attention category by adding [[Category:Needs Attention]] to the page. </translate>