Code Monkey home page Code Monkey logo

tw-livre's Introduction

TW Livre - technical writing livre e open-source <3

Sobre o projeto

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.

Website e redes

Roadmap (Futuro)

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.

Por que open source?

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.


Instruções gerais

Ver a versão mais recente do projeto

Você pode ver a versão mais recente do TW Livre gerada e publicada aqui: https://www.twlivre.org/

Executar o projeto localmente

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:

  1. Faça um clone do repositório do TW Livre. Alternativamente, faça um fork do repositório antes de clonar.
  2. Abra um terminal de comando e navegue até o diretório raiz do seu projeto clonado.
  3. Execute o seguinte comando no terminal:
    • bundle exec jekyll s
  4. Acesse o seguinte endereço no seu navegador:
    • http://localhost:4000/

Conheça os frameworks e tecnologias usados pelo projeto.

Contribuições

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.

Conduta

O Código de Conduta do TWL se baseia no Contributor Covenant para manter o melhor ambiente possível para a comunidade.

Licença

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.

tw-livre's People

Contributors

james-sabel avatar michellemello avatar

Stargazers

 avatar brendo avatar  avatar ana-furlanes avatar Luna Costa avatar Vitória Avendaño avatar

Watchers

 avatar

Forkers

michellemello

tw-livre's Issues

Personalizar página de erro 404

A página de 404 (Not Found) do projeto está com o template padrão do Jekyll. Esta página precisa ser personalizada para ficar com a cara do site.

Revisar código para substituir HTML e CSS por Kramdown

Trechos em HTML e CSS devem ser mantidos a um nível mínimo nas páginas do curso. A preferência é manter o conteúdo o máximo possível em Markdown. Também pode ser usada a variação Kramdown, a qual também é suportada pelo Jekyll.

Algumas páginas ainda apresentam código HTML e CSS, sendo necessário revisar e adequar para um formato em Markdown onde for possível.

Adicionar breadcrumbs nas páginas do curso

A inclusão de breadcrumbs nas páginas do curso tornaria a navegação melhor em termos de usabilidade.

O ideal é usar algum recurso do Jekyll para que os breadcrumbs sejam gerados automaticamente, evitando a necessidade de mantê-los manualmente.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.