training-center / training-center.github.io

Site do Centro de Treinamento

Training Center site

Sobre

Este projeto é um site estático gerado automaticamente pelo Jekyll, um gerador de páginas estáticas, para facilitar a configuração do site e das páginas e a manutenção do código.

Além do Jekyll, utilizamos o Netlify, um serviço de build, deploy e gestão de projetos, para Continuous Deploy e HTTPS.

Utilizamos o dunders, um starter theme, para agilizar a criação do nosso tema para o Jekyll.

Requisitos

Para rodar este site localmente será necessário a instalação das seguintes dependências:

• Ruby
• Jekyll

Para a instalação do Ruby, recomendamos a utilização de um gerenciador de versões, como o RVM e para a instalação do Jekyll basta seguir a documentação do Jekyll.

Caso você não consiga instalar alguma das dependências, pode abrir uma issue neste repositório para lhe auxiliarmos.

Rodando localmente

Clone nosso projeto para o seu ambiente de desenvolvimento.

git clone [email protected]:training-center/training-center.github.io.git

Execute o comando bundle para instalar as dependências do Jekyll e do dunders.

bundle

Agora basta rodar o comando para subir o site em sua máquina, o jekyll s.

jekyll s

O site estará disponível em localhost:4000.

Deploy para produção

Todo merge feito em nossa branch master gera um deploy automático no Netlify.

Estrutura de arquivos

assets

Nossas imagens, fontes, etc.

_includes

As partials do nosso site, os "pedaços" do site.

• analytics.html: o arquivo de configuração do Google Analytics
• footer.html: o footer do template
• head.html: o head da página
• header.html: o header do template

_layouts

O scaffolding para o Jekyll gerar nosso site.

Mais informações sobre isso aqui.

_sass

Todos os módulos Sass do nosso site.

css

O arquivo principal que importa nossos modulos Sass para a geração do tema.

Outros arquivos

• CNAME: mapeamento do nosso domínio para o DNS
• _config.yml: o arquivo de configuração do nosso site
• index.html: o index do site
• robots.txt: muito importante para SEO, confira aqui

Como contribuir

Veja nosso CONTRIBUTING.md

License

Este site é regido pela licença MIT.

training-center.github.io's Issues

Data Tracking e Analytics

Galera, não sei se alguém já pensou/fez isso.

Mas o que acham de colocar, pelo menos, um tracking go Google Analytics no site?

Assim da pra saber qual tipo de publico o site vai ter que atender.

(conversa inicial) Planejamento para desenvolvimento do site do Training Center

Alinhamento

Essa issue servirá para discussão sobre criação de um site para o Training Center e seus projetos.

O Training Center possui, hoje, as informações a respeito dos projetos através dos repositórios GitHub:

• https://github.com/training-center/mentoria < mais ativo
• https://github.com/training-center/study-groups
• https://github.com/training-center/dojos
• https://github.com/training-center/sobre < sobre nós
• https://github.com/training-center/projects
• https://github.com/training-center/materials

Precisamos desenvolver um site para centralizar todas essas informações.

Hoje temos a seguinte página: https://training-center.github.io/

E já começamos o planejamento de um site na issue: training-center/study-groups#46

Vamos mover a discussão pra cá!

O que precisamos?

Precisamos de um site institucional para que as pessoas conheçam o Training Center com as informações do repositório sobre-nos e algumas páginas internas sobre os projetos.

Em suas páginas internas precisaremos de uma maior interação.

Páginas sugeridas

• Mentoria
• Study Groups

Na página do Mentoria pensamos coletar dados do GitHub para exibir as issues abertas e poder filtrar por labels, também precisamos buscar lista de Mentores e Pupilos cadastrados (podendo ser via JSON).

Na página do Study Groups precisamos destacar quem está participando dos grupos de alguma maneira para animar as pessoas por estarem estudando. Talvez um esquema de badge ou subir de posição em um hanking baseado em alguma pontuação.

Estrutura

Podemos seguir o esquema usado no projeto Eventos do FrontEndBR.

• Um arquivo JSON vai receber os dados dos Mentores que serão preenchidos via PR pelos próprios novos Mentores.
• Tendo o arquivo, um esquema de template renderiza a lista com paginação, filtros e uma boa usabilidade para o usuário final
• Devemos seguir o esquema das labels (Mentoria, Study Groups) para os filtros no site para haver consistência entre o que já fazemos com o novo fluxo

Tecnologias

Devemos discutir isso nessa issue com base em quem poderá ajudar o projeto.

Checklist

• Criação de estrutura do projeto com definição de diretórios
• Modificações no layout para estruturar as novas páginas
• Configuração de task runner
• Criação do html + css - ainda sem integração com JSON
• Script pra ler o JSON e renderizar o template
• Script pra filtros (labels aqui do repo, preço, local)
• Paginação

Bora agitar, @training-center/mentors @training-center/pupils @training-center/moderators @training-center/study-groups

Atualização/Modificações no Layout para adicionar novos requisitos

Conforme alinhado na issue #1 definimos separar os tópicos da issue em outras issues mais específicas.

Os requisitos estão sendo levantados na issue #2. Assim que a mesma estiver dada por finalizado, pode-se existir alterações no layout (:metal:) que já possuímos criado pelo @baltazarparra e vamos utilizar essa issue para discussões sobre essas modificações.

Desenvolvimento da aplicação

Desenvolvimento da integração com APIs, filtros e paginação.

Checklist

• Script pra ler o JSON e renderizar o template
• Script pra filtros (labels aqui do repo, preço, local)
• Paginação

Aguardando maiores definições na #3

Definição das tecnologias a serem utilizadas no projeto

Conforme alinhado na issue #1 definimos separar os tópicos da issue em outras issues mais específicas.

Uma estrutura básica já foi citada na issue na sessão Estrutura onde:

• Um arquivo JSON vai receber os dados dos Mentores que serão preenchidos via PR pelos próprios novos Mentores.
• Tendo o arquivo, um esquema de template renderiza a lista com paginação, filtros e uma boa usabilidade para o usuário final
• Devemos seguir o esquema das labels (Mentoria, Study Groups) para os filtros no site para haver consistência entre o que já fazemos com o novo fluxo

Como no projeto Eventos do FrontEndBR.

Na issue chegamos a "conclusão" de se usar React para os templates e podemos contar com a ajuda/coordenação do @matmarsiglio para isso

Nessa issue devemos discutir aspectos técnicos do projeto como qual task runner usar, estrutura de diretórios, etc

a11y - Remover target="_blank" dos links

Pessoal, como solicitado pelo William, estou abrindo essa issue para remover os target="_blank" dos links do site do Training Center.

Esse atributo não é recomendado pois pode gerar alguns problemas de acessibilidade para pessoas com dificuldades em navegar pela Internet.

Entre outros problemas, alguns são:

1. Ocorrer desorientação quando uma nova janela se abrir
2. Não existe o "Botão Voltar" como temos no browser
3. Alguns equipamentos não permitem abrir novas janelas

A melhor opção seria remover esse atributo e deixar que as pessoas escolham se querem ou não abrir o conteúdo do link em uma nova janela/aba.

Essa é uma issue que considero good first issue e acredito que seja uma ótima oportunidade para um iniciante tentar enviar o PR.

Me coloco a disposição, não só pra esclarecer mais sobre o assunto, quanto para auxiliar na criação do PR.

Definição de funcionalidades/requisitos do projeto

Conforme alinhado na issue #1 definimos separar os tópicos da issue em outras issues mais específicas.

Essa issue é para levantamento das funcionalidades do nosso site.

Inicialmente temos:

Um site com uma home page estilo langing page com as informações sobre o Training Center de uma maneira convidativa para as pessoas se interessarem a ajudar outras pessoas através do projeto ou apoiarem o projeto de alguma maneira.

Dentro desse site teremos duas páginas, uma para cada projeto principal do Training Center (Mentoria e Study Groups).

Ambas as páginas tem funcionalidades parecidas:

• A página do Mentoria deve listar os Mentores e Pupilos e possuir filtros para ordenar por Mentores que estão aceitando novos pupilos/pupilos que estão buscando mentoria
• A página do Study Groups deve ser outra landing page explicando a ideia de se estudar em grupo e listar os grupos (canais do Slack) que já existem

Caso alguém queira especificar mais alguma funcionalidade que seria interessante, devemos conversar nessa issue.

Atualização do site

Olá, pessoal! Queria saber se vocês estão com algum plano de reformulação do site? Pois tem muitas iniciativas novas que começamos e não constam no site ainda. Inclusive o site ainda está com a logo antiga, acredito eu.

Layout

Pessoa,
Onde eu posso ver o layout do projeto?

Gostaria de tentar ajudar no código do projeto.

Valeu!

Criação do HTML + CSS

Desenvolvimento do HTML + CSS sem integração com dados.

Aguardando maiores definições na #3

Criação da estrutura inicial

Criação da estrutura inicial do projeto com as tecnologias especificadas na #3

Checklist

• Criação dos diretórios
• Configuração de task runner
  • server local
  • build
  • deploy
• estrutura inicial do projeto