|
|
|
# Wiki e Snippets
|
|
|
|
### Wiki
|
|
|
|
Apenas escrever um bom código e fazer testes nem sempre é o suficiente. Uma boa documentação ajuda outras pessoas a entenderem o seu projeto.
|
|
|
|
|
|
|
|
Todo projeto do GitLab vem com uma sessão para guardar a sua documentação, a Wiki.
|
|
|
|
|
|
|
|
Enquanto o arquivo README do projeto deve ser usado para guiar rapidamente o usuário, as wikis devem ir a fundo na implementação.
|
|
|
|
|
|
|
|
As wikis são escritas em [GitLab Flavored Markdown](https://gitlab.c3sl.ufpr.br/help/markdown).
|
|
|
|
|
|
|
|
### Snippets
|
|
|
|
Você pode compartilhar trechos de código, ou códigos fonte inteiros através de snippets. Existem dois tipos: públicos e secretos. Mas não se engane, ambos podem ser vistos por qualquer usuário. A diferença é que snippets públicos aparecem na *public area* enquanto secretos não.
|
|
|
|
|
|
|
|
Snippets são úteis para guardar aquele algoritmo maluco que você sonhou ou para compartilhar com alguém algo que eles necessitam.
|
|
|
|
|
|
|
|
---
|
|
|
|
#### Próximo: [Configure o GitLab](configure)
|
|
|
|
#### Anterior: [Issues e Milestones](issues)
|
|
|
|
###### [Voltar para o início](../home) |
