vuejs-br / docs-next

Documentação do Vue 3 traduzida para Português Brasileiro (WIP).
https://vuejsbr-docs-next.netlify.app
MIT License
99 stars 64 forks source link
hacktoberfest vue vue3 vuepress

vuejs-br/docs-next

Este é o repositório oficial da tradução para português brasileiro da documentação do Vue.js. Este site é produzido com VuePress. Todo o conteúdo é escrito em Markdown e os arquivos podem ser encontrados em src.

Nota da equipe de tradução: o trabalho nesta nova versão da documentação ainda está em andamento, portanto muitos conteúdos estão em seu estado original (em inglês). Ajuda é muito bem-vinda!

Traduzindo

Se você quer participar da tradução, ajudando a traduzir conteúdos que ainda permanecem em inglês e/ou ajudando a revisar conteúdos já traduzidos, sinta-se em casa. Para entender como tudo funciona e saber por onde começar, leia nosso guia de Contribuição com a Documentação.

O workflow para a realização da tradução está detalhadamente descrito em Como colaborar com a versão em português? Ler é o primeiro passo para todo colaborador em potencial.

Escrevendo

Se você quer participar ajudando na construção e atualização da documentação principal (em inglês), veja o Guia de Escrita para regras e recomendações sobre escrever e manter a documentação.

Neste momento a documentação principal (em inglês) está em beta: o time está atualmente no meio de muitas mudanças e não está recebendo contribuições. Todo o conteúdo está sujeito a mudanças. Se você viu algo que gostaria de trazer à atenção do time, crie uma issue e todos farão o possível para analisar. No entanto, provavelmente você precisará esperar até que todo o conteúdo esteja finalizado.

Desenvolvendo

Se deseja executar o projeto localmente, seja para contribuir com a documentação ou seja para olhar como as coisas funcionam, sigua os passos a seguir.

  1. Clone este repositório:
git clone https://github.com/vuejs-br/docs-next.git
  1. Instale as dependências:
yarn # or npm install
  1. Inicie um ambiente de desenvolvimento local:
yarn serve # or npm run serve

Publicando

Netlify Status

O site é automaticamente publicado quando commits chegam em master, via Netlify.

O processo é disparado somente por um grupo de contribuidores selecionados para isso, a fim de manter a organização do projeto. Colabore apenas enviando pull requests e, depois de revisados e aceitos, serão mesclados em master pela equipe. Ou seja, não se preocupe com a publicação, o deploy é automático.