Help:Contribute/pt-br: Difference between revisions
(Created page with "===Relevância===") |
No edit summary |
||
(21 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<languages/> | <languages/> | ||
Esta página contém informações sobre a edição da wiki do KDE TechBase, incluindo | Esta página contém informações sobre a edição da wiki do KDE TechBase, incluindo conteúdo, sua localização e ferramentas úteis específicas desta wiki. Mesmo se você estiver familiarizado com os wikis, você deve ler [[#Organisation|a seção sobre organização]] para ver qual conteúdo deve ser colocado nesta wiki. | ||
==Antes de você começar== | ==Antes de você começar== | ||
Line 15: | Line 15: | ||
===Relevância=== | ===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 | ||
* IPC/RPC | * Interfaces IPC/RPC para software, como interfaces DBus | ||
A documentação do usuário final pertence a [https://userbase.kde.org UserBase], e as coisas direcionadas a colaboradores, equipes e a Comunidade KDE em geral pertencem a [https://community.kde.org the community wiki]. | |||
Exemplos de coisas que '''não''' pertencem a TechBase incluem: | |||
* | * documentação sobre como usar um aplicativo | ||
* | * políticas de estilo de código | ||
* | * informações para novos colaboradores | ||
* | * coordenação da equipe (listas de TODO, anotações de reuniões etc.) | ||
* | * notas sobre a arquitetura interna de um software (mas a arquitetura da API de uma biblioteca pertence) | ||
Mais sobre isso em [https://community.kde.org/Guidelines_and_HOWTOs/Documentation_in_wikis em diretrizes sobre community.kde.org] | |||
==Organisation== | ==Organisation== | ||
{{TODO| | {{TODO|necessário documentar a estrutura}} | ||
== | ==Formatação== | ||
* | *O site principal do MediaWiki possui [http://www.mediawiki.org/wiki/Help:Formatting o Wiki syntax guide] | ||
* UserBase | *O UserBase possui algumas [https://userbase.kde.org/Toolbox listas de formatação] que podem ser uma referência útil, incluindo modelos específicos das wikis do KDE. | ||
* | *Muito do que se aplica à Wikipedia (exceto os templates) também se aplica aqui, incluindo [http://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup] e suas [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet cheatsheet]. | ||
==Wiki | ==Manutenção da Wiki== | ||
Manter uma wiki limpa e útil envolve garantir que o conteúdo esteja atualizado, que não haja links quebrados e que todas as páginas possam ser encontradas (elas estão vinculadas a partir de algum lugar). As páginas especiais a seguir podem ajudar a encontrar problemas que precisam ser corrigidos: | |||
; | ;Problemas que devem ser corrigidos o mais rápido possível | ||
:[[Special:Lonelypages]] | :[[Special:Lonelypages]] | ||
:[[Special:BrokenRedirects]] | :[[Special:BrokenRedirects]] | ||
:[[Special:DoubleRedirects]] | :[[Special:DoubleRedirects]] | ||
; | ;Problemas que devem ser corrigidos a tempo | ||
:[[Special:Wantedpages]] | :[[Special:Wantedpages]] | ||
:[[Special:Wantedcategories]] | :[[Special:Wantedcategories]] | ||
Você também pode adicionar uma página à [[:Category:Needs Attention|Needs Attention]] para sinalizá-la para trabalhos posteriores, adicionando <nowiki>[[Category:Needs Attention]]</nowiki> à página. O uso do [[Template:TODO]] também adicionará uma página a esta categoria. | |||
=== | ===Excluindo páginas=== | ||
A maioria dos usuários não pode excluir páginas na Wiki - isso ocorre porque, uma vez que uma página desaparece, você não pode recuperá-la. Se você acha que uma página deve ser excluída, marque-a com [[Template:Proposed_deletion]] na parte superior: | |||
{{Input|1=<nowiki>{{Proposed_deletion|reason=this page contains only spam}}</nowiki>}} | {{Input|1=<nowiki>{{Proposed_deletion|reason=this page contains only spam}}</nowiki>}} |
Latest revision as of 14:16, 17 October 2019
Esta página contém informações sobre a edição da wiki do KDE TechBase, incluindo 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
A documentação do usuário final pertence a UserBase, e as coisas direcionadas a colaboradores, equipes e a Comunidade KDE em geral pertencem a the community wiki.
Exemplos de coisas que não pertencem a TechBase incluem:
- documentação sobre como usar um aplicativo
- políticas de estilo de código
- informações para novos colaboradores
- coordenação da equipe (listas de TODO, anotações de reuniões etc.)
- notas sobre a arquitetura interna de um software (mas a arquitetura da API de uma biblioteca pertence)
Mais sobre isso em em diretrizes sobre community.kde.org
Organisation
TODO |
---|
necessário documentar a estrutura |
Formatação
- O site principal do MediaWiki possui o Wiki syntax guide
- O UserBase possui algumas listas de formatação que podem ser uma referência útil, incluindo modelos específicos das wikis do KDE.
- Muito do que se aplica à Wikipedia (exceto os templates) também se aplica aqui, incluindo Wiki markup e suas cheatsheet.
Manutenção da Wiki
Manter uma wiki limpa e útil envolve garantir que o conteúdo esteja atualizado, que não haja links quebrados e que todas as páginas possam ser encontradas (elas estão vinculadas a partir de algum lugar). As páginas especiais a seguir podem ajudar a encontrar problemas que precisam ser corrigidos:
- Problemas que devem ser corrigidos o mais rápido possível
- Special:Lonelypages
- Special:BrokenRedirects
- Special:DoubleRedirects
- Problemas que devem ser corrigidos a tempo
- Special:Wantedpages
- Special:Wantedcategories
Você também pode adicionar uma página à Needs Attention para sinalizá-la para trabalhos posteriores, adicionando [[Category:Needs Attention]] à página. O uso do Template:TODO também adicionará uma página a esta categoria.
Excluindo páginas
A maioria dos usuários não pode excluir páginas na Wiki - isso ocorre porque, uma vez que uma página desaparece, você não pode recuperá-la. Se você acha que uma página deve ser excluída, marque-a com Template:Proposed_deletion na parte superior:
{{Proposed_deletion|reason=this page contains only spam}}