A documentação oficial para a atual versão estável do Sails está na branch master deste repositório. O conteúdo da maioria das seções no site oficial do Sails é compilado a partir daqui.
A documentação do Sails foi traduzida para vários idiomas diferentes. A lista abaixo é referente a tradução de projetos que estamos cientes.
| Idioma | Rótulo de Idioma IETF | Versão | Mantenedor(es) | Repositório |
|---|---|---|---|---|
| Japonês | ja |
v0.11.x | @kory-yhg | sails-docs-ja |
| Espanhol | es |
v0.12.x | @eduartua & @alejandronanez | sails-docs-es |
| Português do Brasil | pt-BR |
v1.0.x | @Avlye | sails-docs-pt-BR |
| v0.10.x | @marceloboeira | sails-docs-pt-BR | ||
| Mandarim Taiwanês | zh-TW |
v0.10.x | @CalvertYang | sails-docs-zh-TW |
| Coreano | ko |
v0.10.x | @sapsaldog | sails-docs-ko |
| Chinês | zh-cn |
v0.12.x | @linxiaowu66 | sails-docs-zh-cn |
| Francês | fr |
v0.12.x | @marrouchi | sails-docs-fr |
Como agora estamos usando branches para acompanhar as diferentes versões da documentação do Sails, estamos nos afastando da abordagem original de usar branches para diferentes idiomas. Antes de iniciar um novo projeto de tradução, solicitamos que você revise as informações atualizadas abaixo -- o processo mudou um pouco.
Nós agradecemos sua ajuda! Por favor mande uma pull request para master com as correções/adições e elas serão revisadas e atualizadas assim que possível.
Segundamente, nós estamos abertos para sugestões sobre o processo que usamos para gerenciar nossa documentação e trabalhar com a comunidade em geral. Por favor, poste no Grupo do Google suas ideias- ou se estiver interessado em ajudar diretamente, contate @fancydoilies, @rudeboot ou @mikermcneil no Twitter.
Para fazer edições que sejam relevantes a versão estável do Sails (ex: a versão no NPM), você irá editar a branch master deste repositório (que você vê no repositório sails-docs por padrão). O time principal do Sails atualiza o master nas branches apropriadas para última versão estável do Sails, e assim disponibiliza no Sobre de sailsjs.com uma vez por semana.
Ramo (em sails-docs) |
Documentação de Sails versão... | Acessível em... |
|---|---|---|
master |
Bleeding edge | next.sailsjs.com |
1.0 |
 |
sailsjs.com |
0.12 |
Sails v0.12.x | 0.12.sailsjs.com |
0.11 |
Sails v0.11.x | 0.11.sailsjs.com |
Nós usamos um módulo chamado doc-templater para converter os arquivos .md em HTML para o site. Você pode aprender mais como funciona no repositório doc-templater.
Cada arquivo .md tem sua própria página no site (ex: todas referências, conceitos e arquivos de anatomia), e devem incluir um rótulo especial <docmeta name="displayName"> com uma propriedade value específica ao título da página. Isto impactará como a página da documentação aparecerá nos resultados de motores de busca, e será usado para mostrar o nome no menu de navegação do sailsjs.com. Por exemplo:
<docmeta name="displayName" value="Construindo Pudins Caseiros Personalizados">Mudanças na documentação serão disponibilizadas quando elas forem atualizadas em um ramo especial correspondente a versão estável do Sails (ex: 0.12). Nós não podemos atualizar pull requests mandadas diretamente a esse ramo-- seu único propósito é refletir o conteúdo correspondendo ao hospedado em sailsjs.com, e o conteúdo é atualizado apenas antes de reimplementar no site do sails.
Se você quer ver como as mudanças na documentação aparecerão em sailsjs.com, você pode visitar preview.sailsjs.com. O site de pré-visualização atualiza automaticamente com as mudanças atualizadas na branch master de sails-docs.
Um bom jeito de ajudar o projeto Sails, especialmente se você fala outro idioma além de Inglês nativamente, é voluntariar para traduzir a documentação do Sails. Se você está interessado em colaborar com qualquer projeto de tradução listado na tabela abaixo, contate os mantenedores do projeto de tradução usando as instruções em README no fork.
Se seu idioma não está representado na tabela acima, e você está interessado em começar um projeto de tradução, siga estes passos:
- Faça um fork desse repositório (
balderdashy/sails-docs) e mude o nome de seu fork parasails-docs-{{IETF}}onde {{IETF}} é o rótulo IETF de seu idioma. - Edite o README para resumir seu progresso até então, providenciando qualquer outra informação que ajude outros que estão lendo sua tradução, e deixe contribuidores interessados saber como contatar você.
- Mande uma pull request editando a tabela acima para o link de seu fork.
- Quando estiver satisfeito com sua primeira versão completa de sua tradução, abra uma pergunta e alguém de nosso time de documentação ajudará contentamente a obter uma pré-visualização no contexto do site do Sails, obtenha um domínio (seu, ou um subdomínio em sailsjs.com, qualquer que faça mais sentido), e compartilhe com o resto da comunidade Sails.
Para mais informações na contribuição do Sails em geral, veja o Guia de Contribuição.
O framework Sails é livre e de código aberto sobre a Licença MIT.
(E esses arquivos desse repositório também são.)