Como propor um tutorial

FAQ : Fábrica de Tutoriais do Fórum dos Fóruns

Este repositório tem como finalidade servir como Fábrica de Tutoriais para o Fórum dos Fóruns. Esta documentação explica a forma como novos tutoriais devem ser propostos.

O modelo apresentado a seguir é obrigatório a fim de organizar e padronizar o ambiente de desenvolvimento neste repositório. Se você tiver dúvidas acerca da postagem de novos tutoriais aqui, por favor, peça ajuda através de um ticket de ajuda, ou em qualquer outro canal de comunicação com os moderadores da fábrica.

Propondo Novos Tutoriais

Para propor um novo tutorial, você deverá criar um novo arquivo no diretório de propostas seguindo o modelo explanado abaixo:

Note que os trechos destacados em vermelhos podem ser alterados, isto é, você deve:

• Trocar nome-do-tutorial pelo nome do tutorial. Mas lembre-se que ao invés de espaço, usa-se hífen (-). Além disso, não de deve usar acentos e/ou caracteres especiais, mas somente caracteres em letra maiúscula e de a até z, podendo também incluir números.
• Trocar .extensão pela extensão do tutorial. Se for .css, trocar o nome do arquivo por app.css. Se for .js, trocar o nome do arquivo por app.js; e assim por diante.

Para criar um diretório como o demonstrado acima — que é um modelo requerido —, deve-se:

Criar o arquivo principal (app.extensão) dentro do diretório com o nome do tutorial:

Para isso, crie novo arquivo aqui com o nome:

tutorial-nome-do-tutorial/app.extensao

Note que uma barra foi usada para separar o nome do diretório e o arquivo app.extensao. A barra significa que o arquivo é um filho daquele diretório. Logo, com:

tutorial-nome-do-tutorial/app.extensao

Temos uma estrutura como essa:

+ [Novo Diretório] tutorial-nome-do-tutorial
└── +
    └── [Novo Arquivo] app.extensao

Um exemplo prático é:

Se for um tutorial JavaScript de como adicionar botões no SCEditor, poderíamos usar:
tutorial-adicionar-botoes-abaixo-do-sceditor/app.js

E a estrutura seria:

+ [Novo Diretório] tutorial-adicionar-botoes-abaixo-do-sceditor
└── +
    └── [Novo Arquivo] app.js

Mas ainda teríamos que criar o arquivo de explicação (README.md), conforme visto no modelo acima.

Para isso, dentro do diretório criado, crie mais um arquivo, com o nome README.md. Nesse arquivo, você deverá colocar a explicação de como seu tutorial funciona. Além de explicar como instalá-lo. O formato de arquivo é markdown. Se você não sabe usá-lo, confira este guia do GitHub, que explica como usar o markdown.

Por fim, teríamos esta estrutura:

+ tutorial-nome-do-tutorial
└── +
    ├── app.extensão
    |
    └── [Novo Arquivo] README.md

No exemplo prático anterior, teríamos:

+ tutorial-adicionar-botoes-abaixo-do-sceditor
└── +
    ├── app.js
    |
    └── [Novo Arquivo] README.md

Com isso, você pode propor um novo tutorial para a fábrica.
Se você ainda tiver dúvidas, peça ajuda através de um ticket de ajuda, ou em qualquer outro canal de comunicação com os moderadores da fábrica.

Aconselhamos também a leitura do guia de moderação da fábrica.