Reorganiza documentação

CONTRIBUTING.md

@@ -13,6 +13,7 @@ Menu
   * [Adicionar vídeos](#adicionar-vídeos)
 
 3. Deploy
+  * [Fazendo o Pull Request](#fazendo-o-pull-request)
   * [Atualizando o site](#atualizando-o-site)
 
 Aviso sobre Síndrome do Impostor
@@ -43,15 +44,15 @@ Obrigada por contribuir!
 Contribuindo
 ============
 
-1. Fork o projeto
-2. Crie uma branch para a feature em que trabalhará: `git checkout -b minha-nova-feature`
-3. Faça commit das suas alterações: `git commit -m 'Adiciona alguma feature'`
-4. Faça push desses commits para sua branch: `git push origin minha-nova-feature`
-5. Envie um pull request para o nosso repositório
+1. Faça o fork do projeto
+2. Clone o projeto para a sua máquina `git clone https://github.com/<seu_usuario>/br-pyladies-pelican.git`
+3. Crie uma branch para a feature em que trabalhará: `git checkout -b minha-nova-feature`
+4. Faça commit das suas alterações: `git commit -m 'Adiciona alguma feature'`
+5. Faça push desses commits para sua branch: `git push origin minha-nova-feature`
+6. Envie um pull request para o nosso repositório
 
 **Observação**: Nós usamos português como linguagem padrão dos commits.
 
-
 Preparando o ambiente local
 --------------------------
 - Antes de mais nada, verifique se você tem o **Python 3.6.4** instalado na sua máquina.
@@ -61,22 +62,45 @@ Preparando o ambiente local
 Para criar um `virtualenv` e instalar os pacotes necessários para rodar o projeto,
 siga as orientações do capítulo "Instalando e Rodando" do [README](https://github.com/pyladies-brazil/br-pyladies-pelican/blob/master/README.md)
 
-
 Criar um novo Post
 ------------------
 
+#### Linux
+
 Para criar um novo post, rode o comando:
 
-	make newpost NAME='NOME DO SEU POST'
+`make newpost NAME='NOME DO SEU POST`
 
-Ele irá criar um novo arquivo `nome-do-seu-post.md` na pasta `content` e abrirá seu editor favorito com um conteúdo pré-adicionado.  Você só precisará adicionar o restante do conteúdo.
+Ele irá criar um novo arquivo `nome-do-seu-post.md` na pasta `content`
+e abrirá seu editor favorito com um conteúdo pré-adicionado.
+Você só precisará adicionar o restante do conteúdo.
 
-Após terminar o post, renderize-o com o comando:
-
-	pelican content
+Após terminar o post, renderize-o com o comando `pelican content`
 
 Se tudo deu certo, seu novo post já estará disponível na página.
 
+#### Windows
+
+Caso o Makefile não funcione, você pode criar o seu post manualmente!
+Vá até a pasta `content` e abra um arquivo de texto. O nome do arquivo
+deve seguir o padrão `YYYY-MM-DD-nome-da-sua-postagem.md`, por exemplo,
+`2020-10-22-como-fazer-um-novo-post.md`.
+
+Após abrir o arquivo de texto, insira o seguinte cabeçalho no início
+```raw
+title: <seu título>
+date: <data da postagem>
+category: <categoria do seu post>
+tags:
+comments: true
+author: <seu nome!>
+```
+
+Depois disso, é só escrever a sua postagem!
+
+**Observação**: Os arquivos são formatados como `Markdown`, então
+talvez seja interessante fazer uma busca simples pra ver como colocar
+elementos básicos como títulos, links e até trechos de código.
 
 Criar uma nova Página
 ---------------------
@@ -163,6 +187,33 @@ Editar Layout
 O site PyLadies utiliza um framework CSS chamado [Foundation](http://foundation.zurb.com/sites.html). Antes de escrever estilos para algo em particular, recomendamos verificar se o framework não oferece a funcionalidade ou estilo desejado, bastando que seja aplicada uma classe específica ao HTML.
 
 
+Fazendo o Pull Request
+-----
+
+Na hora de fazer o pull request é bem legal você prestar atenção em
+algumas pontos:
+* Definimos que nosso padrão de código é em português, então se possível se lembre de manter
+tanto as mensagens de commit quando o próprio título do Pull Request em português
+* Marque o time de tecnologia para que seu PR seja revisado mais rapidamente!
+Pra fazer isso, vá até o canto direito da sua tela no momento em que estiver
+abrindo o PR, clique na engrenagem ao lado do título _Reviewers_ e digite
+`tech-team`. Ao aparecer o ícone, clique nele.
+![reviewers](content/images/contributing/reviewers.png)
+
+* Se coloque como _assignee_ da tarefa. Dessa forma as notificações chegam pra
+você mais rápido. Pra fazer isso, clique na engrenagem ao lado do nome _Assignees_
+e procure pelo seu usuário do github **ou** clique em _assign yourself_.
+![assign_yourself](content/images/contributing/assign_yourself.png)
+![search_assignees](content/images/contributing/search_assignees.png)
+
+* Coloque uma _label_ no seu PR. Dependendo da sua modificação, temos labels
+diferentes, veja a que melhor se encaixa com as modificações que você está
+propondo no PR. As mais comuns são `content (conteúdo)`, `documentation` e
+`enhancement`.
+![labels](content/images/contributing/labels.png)
+* Agora você está mais do que pronta pra submeter o seu PR pra gente revisar!
+
+
 Atualizando o site
 ------------------
 
@@ -172,3 +223,4 @@ Além disso, o time responsável por manter o site será marcado para revisar as
 Para verificar se suas mudanças estão da forma que você espera, basta verificar o status check de deploy preview, clicar em detalhes e você vai ser redirecionada para um site com as suas mudanças.
 
 Se estiver tudo certo, basta esperar que alguém revise e integre seu pull-request em `master`, o que vai disparar um deploy automático para o ambiente de produção, também conhecido como [nosso site](http://brasil.pyladies.com/).
+

README.md

@@ -9,23 +9,39 @@ Para contribuir com o projeto veja o guia de [Contribuição](https://github.com
 
 Instalando e Rodando
 --------------------
-
+* [Requisitos Mínimos](#requisitos-minimos)
+* [Instalação no Linux](#instalação-no-linux)
+  - [Usando ambiente virtual](#usando-ambiente-virtual)
+  - [Usando docker-compose](#usando-docker-compose)
+* [Instalação no Windows](#instalação-no-windows)
+  - [Usando o docker-compose](#usando-o-docker-compose)
+
+Requisitos Mínimos
+-----
+* Python 3.6
+* [pip](https://pip.pypa.io/en/stable/)
+
+Instalação no Linux
+===============
+
+Usando ambiente virtual
+----
 - Para apenas rodar localmente o site, você precisa do [virtualenv](https://virtualenv.pypa.io/en/stable/)
 instalado na sua máquina. Para verificar se ele está instalado, execute o
 seguinte comando e observe a saída:
 
 ```console
 $ virtualenv --version
 ```
-- Se a saida for uma numeração, como `16.1.0`, isso significa que o virtualenv já
+- Se a saída for uma numeração, como `16.1.0`, isso significa que o virtualenv já
 está instalado. Caso contrario, para instalar o virtualenv basta fazer:
 
 ```console
 $ pip install virtualenv
 ```
 - O mesmo procedimento pode ser feito para o git. Verifique se já está instalado,
 com o comando:
-``` console
+```console
 $ git --version
 ```
 
@@ -40,17 +56,17 @@ $ sudo apt install git  # para ubuntu
 
 - Assumindo que seu git e virtualenv já estão configurados, faça o clone do repositório
 
-``` console
+```console
 $ git clone https://github.com/pyladies-brazil/br-pyladies-pelican.git
 ```
 - Após conclusão do clone, acesse o diretório recém-criado
 
-``` console
+```console
 $ cd br-pyladies-pelican
 ```
 - Rode o comando para criação de ambiente virtual e instalação das dependências
 
-``` console
+```console
 $ virtualenv .venv 	# cria ambiente virtual
 $ source .venv/bin/activate	# ativa o ambiente
 $ pip install -r requirements.txt	# instala as dependências
@@ -59,7 +75,7 @@ $ pip install -r requirements.txt	# instala as dependências
 
 - Rode o projeto
 
-``` console
+```console
 $ make up
 ```
 
@@ -85,16 +101,7 @@ Para mais informações a respeito do `Makefile` e suas opções, digite
 $ make help
 ```
 
-Links Úteis
------------
-
-* [Documentação Pelican](http://docs.getpelican.com/en/3.6.3/)
-* [Virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
-* [Pyenv](https://github.com/yyuu/pyenv)
-* [Criar um grupo PyLadies](https://brazilpyladies.gitbooks.io/handbook/content/)
-* [Documentação git](https://git-scm.com/doc)
-
-Rodando com docker-compose
+Usando docker-compose
 --------------------------
 
 Instale [o docker no seu computador](https://docs.docker.com/install/) em seguida execute os passos abaixo:
@@ -105,12 +112,14 @@ $ cd br-pyladies-pelican
 $ docker-compose up
 ```
 
-Agora basta acessar o navegador em [localhost:8000](http://localhost:8000) para ver o conteúdo gerado.
 
-Instalando e Rodando no Windows (Docker)
+Instalação no Windows
+===============
+
+Usando o docker-compose
 --------------------------
 - [Opcional] Instale o [Visual Studio Code](https://code.visualstudio.com/) para fazer códigos legais;
-- [Opcional mas fortemente indicado] Instale o [Git para Windows](https://desktop.github.com/) para um shell mais legal também;
+- [Opcional mas fortemente indicado] Instale o [Github Desktop](https://desktop.github.com/) para uma interface legal também;
 - Python 3.8 está disponível na loja do Windows e você deve instalar também. Só procurar e clicar em obter que está tudo certo;
 - Abra o Windows Powershell como administrador e faça a instalação do [chocolatey](https://chocolatey.org/install). Com ele poderemos instalar o comando make que será utilizado junto ao Docker;
 - Com o comando *choco* sendo reconhecido no Windows, [instale o make](https://chocolatey.org/packages/make) com `choco install make`;
@@ -135,6 +144,14 @@ Instalando e Rodando no Windows (Docker)
     $ make up
     ```
 
--------------------------
+Links Úteis
+-----------
+
+* [Criar um grupo PyLadies](https://brazilpyladies.gitbooks.io/handbook/content/)
+* [Documentação Docker](https://docs.docker.com/)
+* [Documentação git](https://git-scm.com/doc)
+* [Documentação Pelican](http://docs.getpelican.com/en/3.6.3/)
+* [pyenv](https://github.com/yyuu/pyenv)
+* [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
 
 Esse repositório é mantido com :heart: pelo @pyladies-brazil/tech-team

content/pages/about.md

@@ -1,4 +1,4 @@
 title: About
 tags: pyladies, women, python
-description: Pyladies - Sobre
+description: PyLadies - Sobre
 template: about