SDB:Howto (Como fazer)
Índice
Situação
Este artigo da SDB (base de dados de suporte) explica como escrever artigos para a SDB.
Procedimento
Artigos SDB são escritos para oferecer soluções para os eventuais problemas com que os usuários do openSUSE possam se deparar, mas também para dar explicações mais detalhadas a respeito de certos tópicos. Se surgirem problemas com o openSUSE, a Base de dados de suporte é o primeiro lugar onde se deve procurar ajuda.
Um artigo SDB deve ser subdividido, contendo as seguintes partes:
- Situação
- Procedimento
- Links
ou
- Sintoma
- Causa
- Solução
- Links
Por favor, observe que artigos da SDB, se possível, devem sempre descrever a solução mais fácil. No entanto, é desejável também mostrar a solução mais rápida possível, utilizando a linha de comando ou através da edição dos arquivos de configuração. Neste caso, a seção "Solução" deve ser dividida em várias subseções.
Antes de entrar em detalhes sobre a sintaxe, aqui está um exemplo: (a Predefinição:Artigo SDB está disponível para quando se cria um novo artigo para a SDB).
Criando um novo artigo
Em seu navegador da Web, digite o título do novo artigo após SDB: na linha de URL. Se o artigo ainda não existe, clique em "Editar" para criar e editá-lo.
Todos os artigos SDB devem começar com SDB:, isto facilita muito encontrá-los e constitui uma seção separada no Wiki.
Traduções
Atualmente o wiki openSUSE suporta múltiplos idiomas. Se gosta, e se souber um desses idiomas, por favor, traduza o seu artigo. Se você não quiser, ou não tem certeza de ser fluente o suficiente no idioma estrangeiro, por favor escreva um e-mail para a lista de discussão openSUSE-wiki e peça a alguém para traduzir o seu artigo.
Se você traduziu um artigo, por favor, adicione os links "Interwiki" no final do artigo. Como exemplo, se você tiver um artigo traduzido do alemão para o inglês, você adicionará o seguinte, no final do artigo em alemão:
[[en:SDB:<Nome_do_artigo>]]
Na versão em inglês, adicione o seguinte:
[[de:SDB:<Nome_do_artigo>]]
Alterando artigos existentes
O espaço nominal SDB está incluído no processo de revisão. Se um artigo for editado as alterações serão revistas e estarão visíveis a todos os usuários após serem revistas.
Categorias
Cada artigo SDB deve estar acessível através de categorias. É possível encontrar uma lista de categorias disponíveis em:. Adicione as categorias no início do artigo:
[[Categoria:SDB:8.0|A]] [[Categoria:SDB:Rede|A]]
A categoria é seguida por uma palavra ou locução caracterizante e pela primeira letra do título do artigo. No exemplo acima, Predefinição:Artigo SDB, o artigo é chamado "Alterando Servidores NTP", por isso a caracterizante é seguida pela letra "A".
Sintaxe
Por favor, leia as {{Ajuda:Estilo|orientações]] de estilo para o wiki e obtenha uma visão geral de como formatar o codsnteúdo de um artigo.
Estilo
Como se dirigir aos leitores
Os artigos SDB em alemão SDB devem usar a forma polida de abordagem com o Sie", pois este é o padrão na documentação técnica. Se isso se aplica ao seu idioma, use a forma polida, também. Os autores em inglês, claro, não têm esse problema.
Terminologia em outros idiomas
Noutros idiomas que não o inglês, algumas vezes é difícil traduzir sem os termos técnicos originais em inglês. Por favor, tente escrever de maneira tal que o mais amplo grupo de usuários da SDB considerem útil o seu artigo, mas não tente encontrar traduções quando os termos em inglês são, costumeiramente, entendidos e usados no idioma alvo. Uma boa solução é usar ambos, termo a traduzir e a tradução entre parênteses, como neste exemplo: É possível ir para o "console" (linha de comando) através de CTRL-ALT-F2.
Fácil!
Mesmo que susar o shell, por vezes, pareça mais fácil, especialmente para você: por favor, tente manter em mente os iniciantes em Linux e também explique como um problema pode ser resolvido com as ferramentas do YaST2 ou outros.
Um bom artigo SDB deve descrever cada passo ou um link para outro artigo, onde a explicação específica é fornecida. Portanto, não escreva:
In /etc/inittab, change the default runlevel to 3.
mas:
Entre como usuário root e abra o arquivo /etc/inittab com o editor de sua escolha (e. g., vi ou pico). Altere a linha id:5:initdefault: para id:3:initdefault: para que o sistema não inicialize mais na interface gráfica de usuário.
Isto não é para ser uma exigência difícil! Mas lembre-se que muitos novatos em Linux usam o openSUSE também.
Manutenção
É freqüentemente necessário ajustar artigos SDB para novas versões do openSUSE, ou mesmo para escrever novos, se as alterações são muito fundamentais. Por favor, tente manter os seus artigos de SDB. Como um exemplo, se você percebe que o seu artigo não se aplica mais com a mais recente versão do openSUSE, por favor, mude a linha "versão ".