Repositório do site informativo sobre a iniciativa Núcleo de Reparo de Ventiladores Mecânicos. |
- Ter um local acessível, público e transparente para toda e qualquer pessoa sobre todo trabalho voluntário realizado durante a vigência das atividades. Assim, espera-se que as lições aprendidas possam ser melhor repassadas com esta documentação e que o site (hospedado aqui) permaneça ativo para sempre.
- Aproveitar a dificuldade de se disponibilizar esta documentação de forma digital e atualizada como oportunidade de aprender sobre projetos open source, em que direciona-se primariamente à desenvolvimento de software. Embora documentação seja muitas das vezes negligenciada, é um processo importante do desenvolvimento de qualquer projeto, sendo de software ou não. Por isso a construção do site encaixa-se bem neste perfil.
- Integrar os voluntários tanto através da documentação de suas experiências na manutenção, quanto pela contribuição daqueles que estão dando suporte remoto.
- Ter um único local para identificação da iniciativa, dos projetos e dos voluntários. Assim têm-se confiança para compartilhar os resultados em redes sociais e conseguir novas parcerias e contribuições financeiras.
Toda contribuição é bem-vinda para melhor permitir a divulgação das informações. No entanto, precisamos seguir algumas recomendações antes de implementar alguma mudança, visto que teremos várias pessoas trabalhando em conjunto. Em suma, é necessário ter conversa. E o lugar para começar isso é na aba de Issues. Lá discute-se perguntas e sugestões antes de realizar qualquer modificação nos códigos. De vez em quando pode acontecer de uma pessoa não entender o que a outra escreveu (principalmente se não a conhece pessoalmente), mas pode ter certeza que ninguém está distribuindo desaforos. Tenha empatia, criatividade e gargalhadas para contornar a situação. 😎
Há duas formas principais de contribuir, seja criando conteúdo, seja ajeitando as configurações. Por questões de integridade e bom funcionameto do site, é boa prática não realizar as mudanças diretamente no ramo (branch) master. Assim, temos dois ramos adicionais (doc e config) para acomodar os dois tipos de contribuições comentados. As seções a seguir detalham como proceder com as edições online, ou seja, diretamente pelo site do GitHub.
- Altere para o ramo
doce escolha o arquivo que deseja modificar. - Neste ramo, o mais comum é alterar e criar conteúdos referentes a pasta
_posts, pois lá se encontra a maior parte do texto que aparece no site. Utilize o mesmo estilo de escrita daqui do GitHub, que utiliza Markdown (arquivo terminado em.md). - Copiar um arquivo já existente ajuda a não ter problemas de configuração, pois cada arquivo de texto possui um
headercom as configurações da página. - Ao salvar as alterações (commit) utilize um título direto, coloque na descrição o que achar relevante (não tem problema deixar em branco), e certifique-se de ter selecionado a opção de commit diretamente no branch
doc. - Aguarde a revisão de sua contribuição.
- Altere para o ramo
confige escolha o arquivo que deseja modificar. - Não é recomendado alterar muitas coisas de uma só vez, pois isso dificulta em encontrar erros. Faça alterações por etapas.
- Ao salvar as alterações (commit) utilize um título direto, coloque na descrição o que achar relevante (não tem problema deixar em branco), e certifique-se de ter selecionado a opção de commit diretamente no branch
config. - Aguarde a revisão de sua contribuição.
Se ficou em dúvida com alguma coisa ou deseja conversar sobre algo a mais, pode iniciar um Issue e me marcar na descrição utilizando @yurigabrich. Ou enviar e-mail para [email protected].
- A TeaGuns por disponibilizar o modelo Jekyll Odin. Mais informações em seu repositório.
- As instruções de Kwanghoo Park em seu blog sobre como criar um site multilíngue.
- A todos os voluntários que vem contribuindo direta e indiretamente para o sucesso desta iniciativa.