Ajuda:Contribuir
Esta página contém informações sobre a edição da wiki do KDE TechBase, incluindo que conteúdo, sua localização e ferramentas úteis específicas desta wiki. Mesmo se você estiver familiarizado com os wikis, você deve ler a seção sobre organização para ver qual conteúdo deve ser colocado nesta wiki.
Antes de você começar
Começando pelo começo
- Para contribuir com a TechBase, você deve registrar uma conta no KDE Identity service e então ativá-la no Phabricator fazendo login por lá e, em seguida, você pode clicar no link Login with Phabricator na barra lateral para fazer login.
- Lembre-se de que você deve concordar que suas contribuições lançadas nesta wiki estão sob as licenças listadas em KDE TechBase: Copyrights. Essas licenças significam que o que você escreve pode ser copiado para outros sites, por exemplo.
- Use as Páginas de discussão para se comunicar com outros colaboradores ou obter ajuda. Normalmente, alguém responderá dentro de um dia.
Relevância
Este wiki é para documentação de desenvolvedores que desejam usar ou estender produtos KDE (por exemplo, via APIs) ou:
- informações gerais para bibliotecas, incluindo as vantagens de usá-las
- tutoriais e exemplos para usar bibliotecas
- tutoriais, exemplos e documentação para escrever plugins e outras extensões para bibliotecas e aplicativos
- Interfaces IPC / RPC para software, como interfaces DBus
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
| 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}}