O TW Livre (TWL) é um site com o propósito de reunir conteúdo educativo sobre redação técnica em português.
O projeto surgiu para disponibilizar o treinamento de TW do Google traduzido e localizado.
Com o projeto open source no GitHub, o TWL vira um espaço colaborativo onde as pessoas podem aprender e ensinar mais, além do treinamento original.
O objetivo do TWL é ser um espaço colaborativo para compartilhar conhecimento e tutoriais sobre redação técnica. Os temas podem variar entre processos, ferramentas e técnicas.
Uma lista de sugestões e ideias de assuntos está disponível no guia de contribuição. Leia o guia para saber também como apoiar.
A ideia de criar o TWL em formato open source apareceu porque acredito que compartilhar conhecimento gera mais conhecimento.
Gosto do modelo colaborativo do open source e acho que tem tudo a ver com a construção de documentação.
Neste formato, o projeto também abre portas para writers que querem começar a contribuir com open source.
Você pode ver a versão mais recente do TW Livre gerada e publicada aqui: https://www.twlivre.org/
Você precisa instalar o Jekyll e dependências dele antes de seguir com as instruções. Para saber como instalar o Jekyll, acesse o guia de instalação padrão no TW Livre. Para ter instruções mais detalhadas sobre todos os tipos de instalação do Jekyll, consulte a documentação oficial da ferramenta.
Para baixar e executar o projeto localmente, siga estes passos:
- Faça um clone do repositório do TW Livre. Alternativamente, faça um fork do repositório antes de clonar.
- Abra um terminal de comando e navegue até o diretório raiz do seu projeto clonado.
- Execute o seguinte comando no terminal:
bundle exec jekyll s
- Acesse o seguinte endereço no seu navegador:
http://localhost:4000/
Conheça os frameworks e tecnologias usados pelo projeto.
Você pode contribuir com o TWL das seguintes maneiras:
- criando issues para:
- relatar erros e problemas com o site
- relatar erros e problemas com o conteúdo do curso e tutoriais
- propor melhorias no site
- propor melhorias no conteúdo dos cursos e tutoriais
- enviando seu próprio pull request
Leia o guia de contribuição antes de enviar pull requests.
O Código de Conduta do TWL se baseia no Contributor Covenant para manter o melhor ambiente possível para a comunidade.
O conteúdo do TWL está sob a licença de Atribuição-NãoComercial-CompartilhaIgual 4.0 Internacional (CC BY-NC-SA 4.0). Qualquer contribuição feita ao projeto estará sujeita às condições desta licença.