Este repositório contem os arquivos que geram o site do MonoBrasil http://www.monobrasil.com.br com base na versão do site original do Projeto Mono http://www.mono-project.com.
O site usa a ferramenta Jekyll (http://jekyllrb.com), um gerador de site estático. O GitHub Pages, onde o site está hospeado, suporta nativamente o Jekyll de forma que cada vez que alguém publica um comite neste repositório, o site será reconstruído e atualizado (após alguns segundos a minutos). Para hospedar o site você mesmo, veja Setting up a local copy of the website.
Um passo-a-passo simplificado:
- Tudo acontece aqui no GitHub, então o primeiro passo é você criar a sua conta aqui. Como é só para repositório abertos é sem custo.
- Depois você tem criar um fork seu deste repositório https://github.com/MonoBrasil/website. É só clicar no botão fork no canto superior direito.
- Os caminhos na planilha de planejamento são os caminhos dentro do repositório e a maioria das páginas estão em MarkDown não em html.
- Para páginas pequenas dá para editar diretamente no github, navegue até o arquivo, e clique no link da canetinha.
- Cuidado para não alterar comandos do processador de geração do site (Jekyll) normalmente o que está no topo entre duas linhas marcadas com ---, apenas o texto que está após o prefixo title: na primeira linha deve ser traduzido.
- Cada vez que você salvar as alterações estará fazendo um commit no seu fork.
- Para trabalhos maiores, é interessante fazer um clone do seu repositório em um ambiente que suporte git (Eclipse,Visual Studio, Linux em linha de comando, GitHub for Windows) para poder fazer as alterações em um editor de texto como o Notepad++,Vim,etc... só que aí tem que fazer em duas etapas commit local e pull para o seu fork.
- Quando quiser enviar o que você realizou até o momento, você deve fazer um Pull Request (use o link Compare no topo da página raiz do seu repositório e depois o botão Create Pull Request).
- Envie um email do seu PR para o revisor correspondente na planilha. O revisor deverá colocar comentários para a melhoria da tradução no próprio PR e ao final marcá-lo com um
, que nós commiters vamos olhar e comitar a contribuição da dupla.
- Para fazer as correções pedidas pelo revisor é melhor usar uma cópia local do seu repositório para fazer um commit -amend (que reincorpora as alterações diretamente no PR já aberto). Aí atualizaremos o percentual do seu trabalho na planilha e aí é só partir para o abraço.
- Caso o revisor não der sinal de vida em um prazo de 2 ou 3 dias, você manda um email na lista do MonoBrasil ([email protected]) para olharmos o seu PR e a coisa não estancar.
Nota: Problemas maiores ou pedidos de funcionalidades devem ser preenchidos no Controle de Problemas primeiramente, para que possamos discutir as implicações.
Se você quer editar uma página, a forma mais fácil é clicar no link debaixo do título da página.
Isto irá abrir o arquivo fonte no GitHub onde você pode clicar o botão com ícone de um lápis e começar a editar:
O editor do GitHub's mostra tanto o fonte em Markdown como também um preview da página renderizada:
Depois de terminar as suas mudanças, entre um sumário e uma descrição e clique no botão "Propose file change" para abrir um pull request:
Blogar é muito fácil com o Jekyll. Simplesmente adicione um novo arquivo Markdown no diretório _posts
seguindo a convenção de nome de arquivo: ANO-MÊS-DIA-título.md
(ANO/MÊS/DIA em forma numérica com zeros à esquerda)
Tenha cuidado de não incluir caracteres especiais no nome do artigo e use '-' ao invés de espaços. A data de publicação da postagem será automaticamente extraída do nome do arquivo.
_includes
- pasta especial contem pedaços reutilizáveis que podem ser incluídos via{% include file.html %}
em outras páginas_layouts
- pasta especial contem os leiautes compartilhados entre as páginas. Leiautes podem ser herdados, o leiaute raiz é obase.html
_posts
- pasta especial, contem as páginas fonte da seção de blog, see Escrevendo uma postagem para o blogt_site
- a saida gerada pelo Jekyll por default é colocada nesta pastaarchived
- conteúdo que não é mais relevante mas mantido para manter links externos funcionandocommunity
- contem os fontes das páginas da seção da comunidade no sitecss
- contem as folhas de estilo cssdocs
- contem os fontes das páginas da seção de documentaçãodownload
- contem os fontes das páginas da seção dedownload
images
- contem as imagens usadas nas páginasnews
- lista as páginas contidas no diretório_posts
Para mudanças maiores, usar o editor web do GitHub não é muito conveniente. Uma forma melhor é criar uma cópia local para experimentar com ela.
- Ruby - Jekyll é escrito em Ruby
- Bundler - um gerenciador de pacotes para Ruby. Instale-o rodando
gem install bundler
Depois que você clonou o seu fork do repositório, rode os seguintes comandos:
bundle install
- baixa as bibliotecas necessárias ao Jekylljekyll serve
- constroi o site e roda um servidor local na porta 4000
Nota: você pode adicionar a opção --watch
ao executar jekyll serve
para que o Jekyll monitore as mudanças de arquivo, o que significa que o site será reconstruido quand um arquivo é modificado.