Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move README from "readme" branch to "source" #21

Merged
merged 1 commit into from
Mar 11, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 65 additions & 95 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,124 +1,94 @@
# Project Zeppelin / GDG DevFest 2014 site template
# GeekNight Recife [![Status das Dependências](https://gemnasium.com/geeknightrecife/geeknightrecife.github.io.svg)](https://gemnasium.com/geeknightrecife/geeknightrecife.github.io)

### About
Project Zeppelin allows you to setup awesome GDG DevFest site in 5 minutes.
Website do GeekNight Recife.

Project is built on top of [Jekyll](http://jekyllrb.com/) - simple, blog-aware, static site generator. Jekyll also happens to be the engine behind GitHub Pages, which means you can use Jekyll to host your website from GitHub’s servers for free. [Learn more about Jekyll](http://jekyllrb.com/).
__No momento o status do build é:__

Template is brought by [GDG Lviv](http://lviv.gdg.org.ua/) team.
[![Build Status](https://travis-ci.org/geeknightrecife/geeknightrecife.github.io.svg?branch=master)](https://travis-ci.org/geeknightrecife/geeknightrecife.github.io)

### Live demo http://gdg-x.github.io/zeppelin/
Este site utiliza o `Project Zeppelin` com diversas customizações. Para informações específicas do template [clique aqui](https://github.com/gdg-x/zeppelin).

#### Automated version with Grunt <https://github.com/gdg-x/zeppelin-grunt>

### Features
* Easy to setup
* Simple and responsive design
* Integrated speakers and sessions management
* SVG icons
* SEO friendly
## Instalando

1. Instale o [Git](http://git-scm.com/downloads) e [Ruby](https://www.ruby-lang.org/en/downloads/), caso ainda não tenha.

### Quick-start guide
1. [Fork](https://github.com/gdg-x/zeppelin/fork) this repo
2. Clone locally
3. Update ```_config.yml```
4. Select what content blocks do you need
5. Push changes to ```gh-pages``` branch
6. Enjoy your awesome DevFest site at ```http://[your github name].github.io/zeppelin/```
2. Clone o projeto

Or watch project presentation from [GDG[x] Townhall meeting](http://www.youtube.com/watch?v=xYmhheoLjcI). Slides available [here](https://docs.google.com/presentation/d/19aM7yNl_orDaCNND5LpCY3fShb6PyMltnzYfKvV8R_8/edit?usp=sharing)
```bash
$ git clone https://github.com/geeknightrecife/geeknightrecife.github.io
```

3. Troque o branch para `source`

## Local development
```bash
$ git checkout source
```

Check if you have [all requirements for local environment](http://jekyllrb.com/docs/installation/).
To install all development dependencies install [Bundler](http://bundler.io/).
```bash
gem install bundler
```
and run next command from root folder:
4. Instale as dependências

```bash
bundle install
```
```bash
$ bundle install
```

To start Jekyll run:
```bash
jekyll serve -w
```
Site will be available at http://127.0.0.1:4000/zeppelin/ or http://localhost:4000/zeppelin/ (on Windows)
5. Ative o watcher para que o site seja recompilado a cada alteração

**NOTE:** in this mode all changes to html and data files will be automatically regenerated, but after changing ```_config.yml``` you have to restart server.
```bash
$ bundle exec jekyll serve --watch
```

### Sass(Compass) support
**Note:** You need to install [Node.js](http://nodejs.org/download/)
## Atualizando

To watch changes of `.sass` files and compile it to the `.css` on a fly change property `safe: true` to `safe: false` in `_config.yml`.
**Note: It works only on local machine, because GitHub runs Jekyll in `--save` [mode](https://help.github.com/articles/using-jekyll-with-pages/#configuration-overrides)**
Antes de começar a modificar a versão atual para adicionar informações de um novo evento, crie uma tag para o último

Learn more about Sass development from [documentation](https://github.com/gdg-x/zeppelin/wiki/Sass-development).
```bash
$ git tag yyyy-MM-DD # E.x.: 2015-07-05
```

1. Para cadastrar um novo evento, atualize os arquivos `location.yml`, `organizers.yml`, `schedule.yml`, `sessions.yml` e `speakers.yml` com as informações do próximo evento.

### Resource optimizations (optional)
2. Caso o participante da edição passada tenha enviado o link para os slides, adicionar o link para a apresentação, inserindo uma key `presentation:` no arquivo `sessions.yml` copiado no passo anterior.

You can optimize images and minify css and javascript automatically (for now only on Windows).
But for Mac OS users available amazing tool - [imageoptim](https://imageoptim.com/). Thanks [@raphaelsavina](https://github.com/raphaelsavina) for link.
Optimize all images by running this script from `/automation/images/` folder:
```bash
all_image_optimization.bat -d -jtran -pout -pquant -optip -gsicle -svgo
```
3. Substituir `heroButtons` no arquivo ```_config.yml```para o link do novo evento do Sympla.

To minify CSS and JS run `minify_js.bat` (for Windows) and `minify_js.sh` (for Linux and MacOS) from `/automation/minifying/` folder:
```bash
minify_js.bat
```
4. Garanta que o parâmetro `preparingNextEvent` do arquivo `_config.yml` esteja setado para false.

Learn more about available optimization options from [documentation](https://github.com/gdg-x/zeppelin/wiki/Resources-optimizations).
5. Adicione as fotos dos palestrantes e patrocinadores de acordo com as guidelines da seção [Guidelines](https://github.com/geeknightrecife/geeknightrecife.github.io#guidelines) TBD

### Documentation
Quick-start guide is not enough? Checkout [full documentation](https://github.com/gdg-x/zeppelin/wiki).
6. Commit e push bara o branch `source`

### Used libraries
* [Bootstrap](https://github.com/twbs/bootstrap)
* [Animate.css](https://github.com/daneden/animate.css)
* [Waves](https://github.com/publicis-indonesia/Waves)
* [jquery.appear](https://github.com/bas2k/jquery.appear)
* [jQuery countTo Plugin](https://github.com/mhuggins/jquery-countTo)
* [Typed.js](https://github.com/mattboldt/typed.js)
* [Sticky-kit](https://github.com/leafo/sticky-kit)
```bash
$ git push origin source
```

### Who is using template?
Going to use template? Go on! The only thing we ask - let us know at [*[email protected]*](mailto:[email protected]) so we can include you to this list, or make a pull request.
7. O Travis CI irá detectar o novo push no branch `source`, e fará o build e publicação do hotsite.

| | | |
|------|------|------|
| [GDG DevFest Ukraine 2014](http://devfest.gdg.org.ua/) | [GDG DevFest Istanbul 2014](http://devfesttr.com/) | [GDG Bangalore Site](http://gdgbangalore.github.io/) |
| [GDG DevFest Omsk 2014](http://gdg-devfest-omsk.org/) | [2014 南阳 GDG Devfest 大会](http://devfest.gdgny.org) | [DevFest Nordeste 2014](http://2014.devfestne.com.br/) |
| [GDG DevFest The Netherlands](http://www.devfest.nl/) | [DevFest Centro-Oeste 2014](http://www.devfestcentrooeste.com.br/) | [Android DevFest Space Coast](http://gdg-space-coast.github.io/zeppelin/) |
| [DevFest SP 2014](http://sp.devfest.com.br/) | [DevFest in Baroda](http://devfest.gdgbaroda.com/) | [GDG Hi Pic (France)](http://maximemularz.github.io/zeppelin/) |
| [GDG DevFest Córdoba 2014](http://gdgcordoba.github.io/zeppelin/) | [GDG DevFest Düsseldorf 2014](http://www.gdg-dus.de/DevFest2014/) | [GDG Makerere DevFest 2014](http://gdgmakerere.github.io/) |
| [GDG Dublin DevFest 2014](http://gdg-dublin.appspot.com/) | [GDG Busitema DevFest 2014](http://gdgbusitema.github.io/) | [DevFest Vienna 2014](http://www.devfest.at/) |
| [Android Wear DevFest](http://devfest.gdgnorthjersey.com/wear2014/) | [GDG SLAU DevFest 2014](http://gdgslau.github.io/) | [Lima DevFest](http://limadevfest.com/) |
| [GDG Korea DevFair 2014](http://devfair2014.gdg.kr/) | [GDG DevFest Kota Kinabalu 2014](http://devfest.gdgkk.info/) | [GDG DevFest Belgium](http://gdg-brussels.org/DevFest2014/) |
| [DevFest Praha 2014](http://devfest.cz/) | [GDG DevFest Kosice](http://devfest.sk/) | [GDG DevFest Cagayan de Oro](http://devfest.gdgcdo.org/) |
| [DevFest Birgunj](http://gdgbirgunj.github.io/DevFest2014/) | [GDG DevFest Poland](http://devfest.pl/) | [GDG DevFest Silicon Valley](http://devfest2014.gdgsv.com/) |
| [DevFest Chennai 2014](http://devfest.gdgchennai.com/) | [GDG DevFest Bari](http://gdgbari.github.io/zeppelin/) | [GDG DevFest Ahmedabad](http://devfest.gdgahmedabad.com/) |
| [GDG DevFest Sri Lanka](http://www.devfestlk.org/) | [GDG DevFest Tunis](http://devfest.gdgtunis.org/) | [GDG DevFest Kozhikode](http://devfest.gdgkozhikode.org/) |
| [GDG DevFest Argentina](http://devfest.gdg.com.ar/) | [GDG DevFest Bhubaneswar](http://devfest2014.gdgbbsr.com/) | [GDG DevFest Miage Gi](http://gdgmiagegilab.github.io/) |
| [GDG DevFest NORTE](http://norte.devfest.com.br/) | [GDG Devfest Nyeri 2014](http://devfest.gdgkimathiuniversity.com/) | [GDG DevFest Paris](http://devfest.gdgparis.com/) |
| [GDG Akure](http://gdgakure.github.io/)|[MENAT GDG Summit 2014](http://summit.gdg-menat.com/)|[Women Techmakers Istanbul 2015](http://wtmistanbul.com) |
| [GDG DevFest Mallorca](http://devfest.gdgmallorca.com/)| [Michigan GDG DevFest 2015](http://michigandevfest.com/) | [International Women's Day](http://iwd.gdgnorthjersey.com/womeninnovation/) |
| [Women Techmakers Tbilisi 2015](http://womentechmakers.ge/) | [Android Xtended](http://www.androidxtended.com/) |[GDG Bingham University](http://binghamuni.edu.ng/gdg)|
| [JSday Maceio 2015](http://jsday.com.br) | [DevFest Nordeste 2015](http://2015.devfestne.com.br) |


### Contributors
* Design and web development: [Oleh Zasadnyy](https://github.com/ozasadnyy)
* Idea: [Vitaliy Zasadnyy](https://github.com/zasadnyy)
* Bug fixing and support: [Said Tahsin Dane](https://github.com/tasomaniac)
8. O progresso do build pode ser acompanhado [aqui](https://travis-ci.org/geeknightrecife/geeknightrecife.github.io)

### License
Project is published under the [MIT license](https://github.com/gdg-x/zeppelin/blob/master/LICENSE.txt). Feel free to clone and modify repo as you want, but don't forget to add reference to authors :)
9. Após a finalização do build com sucesso, a nova versão do site estará disponível [aqui](http://geeknightrecife.github.io)

## Mover os dados do evento anterior para o histórico

1. Criar uma pasta no formato `yyyy-MM-DD` dentro de `_data/archive`

2. Copiar os arquivos `schedule.yml`, `speakers.yml`, `sessions.yml`, `organizers.yml` e `location.yml` para dentro da pasta criada antes de começar a editá-los.

3. Caso o participante da edição passada tenha enviado o link para os slides, adicionar o link para a apresentação, inserindo uma key `presentation:` no arquivo `sessions.yml` copiado no passo anterior.

4. Fazer commit das modificações, gerar uma nova tag com o mesmo nome da pasta e em seguida, push para o repositório remoto

```bash
$ git commit -am 'Archive yyyy/MM event'

$ git tag 'yyyy-MM-DD'

$ git push origin source

$ git push --tags
```

## TODO (Mover as atividades abaixo para issues no GitHub)

- [ ] Cadastrar o histórico de todos os eventos passados
- [ ] Adicionar convenções de tamanhos de imagem e nomenclatura de arquivos aqui no README
- [ ] Form de "quero palestrar inline"
- [ ] Adicionar Gulp para minificação, geração da build, watch etc.