gruntbrasil / grunt-docs

Documentacão do Grunt
77 stars 12 forks source link

Organização e Estrutura #40

Open vitorbritto opened 10 years ago

vitorbritto commented 10 years ago

Acredito que podemos deixar o Home fora da listagem, já que temos um README.md com o sumário apontando para os links dos demais arquivos *.md. Além disso, fica visível para o público.

Por favor, dissertem.

Abraço!

felipefialho commented 10 years ago

@vitorbritto Concordo, facilita o sumário e as informações principais estarem no README.md

felquis commented 10 years ago

Não entendi, a ideia é colocar o README.md no lugar do Home.md?

vitorbritto commented 10 years ago

Não necessariamente! Ambos os arquivos podem permanecer, mas poderíamos retirar o Home.md do sumário no README.md.

felipefialho commented 10 years ago

Acho justo @vitorbritto

felquis commented 10 years ago

Seria legal, termos uma estrutura parecida com o que é usado pelo GruntJS hoje, caso venha a ter um merge no futuro, eles disponibilizando a tradução como na página oficial e tals.

maracaipe commented 10 years ago

@felquis também acho!

vitorbritto commented 10 years ago

Acredito que podemos excluir os arquivos referente ao Blog. Deveríamos nos focar somente na documentação. O que acham?

felipefialho commented 10 years ago

Concordo @vitorbritto

maracaipe commented 10 years ago

Concordo

vitorbritto commented 10 years ago

@felquis :ear:

felquis commented 10 years ago

Esse ouvido ai foi sensacional haha

Se vocês estão de acordo, eu estou de acordo!

2014/1/16 Vitor Britto notifications@github.com

@felquis https://github.com/felquis [image: :ear:]

— Reply to this email directly or view it on GitHubhttps://github.com/gruntbrasil/grunt-docs/issues/40#issuecomment-32465079 .

vitorbritto commented 10 years ago

Hahahaha!

:ear: = fala que eu te escuto! =P

vitorbritto commented 10 years ago

Pronto! @LFeh e @maracaipe, o que acham?

maracaipe commented 10 years ago

Ótima ideia, man!

vitorbritto commented 10 years ago

Senhores, arquivos do Blog serão incluídos aqui.

maracaipe commented 10 years ago

:+1:

vitorbritto commented 10 years ago

Issues para os arquivos atuais do Blog criados.

Assim, ficará bem categorizado e sincronizado.

felipefialho commented 10 years ago

Nice! Parabéns pela organização ; )

maracaipe commented 10 years ago

:ghost:

vitorbritto commented 10 years ago

:tada:

maracaipe commented 10 years ago

A milestone tradução já está nos seus 54%!

vitorbritto commented 10 years ago

Ao finalizar, vou montar uma página para ficar apresentável a documentação. Vou aproveitar para abrir uma issue.

maracaipe commented 10 years ago

Isso aí!

felipefialho commented 10 years ago

@vitorbritto página no GHPages?

vitorbritto commented 10 years ago

Isso @LFeh, já criei o branch. =]

felipefialho commented 10 years ago

Ia sugerir isso, haha. Estamos alinhados :D

Show @vitorbritto

felquis commented 10 years ago

Como que o pessoal do GruntJS usa esses markdown hoje?

2014/1/16 Luiz Felipe Tartarotti Fialho notifications@github.com

Ia sugerir isso, haha. Estamos alinhados :D

Show @vitorbritto https://github.com/vitorbritto

— Reply to this email directly or view it on GitHubhttps://github.com/gruntbrasil/grunt-docs/issues/40#issuecomment-32484187 .

felipefialho commented 10 years ago

@vitorbritto A dúvida do @felquis é bem relevante.

Alias, tem alguma ideia de como ficaria o layout? Se tiver tempo amanhã posso ir adiantando a estrutura base.

vitorbritto commented 10 years ago

@LFeh, o layout será bem simples, já tenho o esqueleto aqui. Nada demais mesmo.

@felquis, quanto ao uso do markdown, vamos utilizar os submodules do git, a fim de apontar para os arquivos *md no repositório. E utilizando Jekyll, vamos fazer o include nas respectivas páginas.

maracaipe commented 10 years ago

Jekkyll + Markdown + Grunt = :heart:

felquis commented 10 years ago

Como que o pessoal do GruntJS usa esses arquivos da documentação? Seria bom manter algo semelhando ao que eles fazem, por que, em determinado momento pode(e seria ótimo) ocorrer um merge deste repo com a documentação oficial né?

Iremos traduzir toda a documentação do GruntJS pra depois trair o movimento Node FTW e usar um Static Generator em Ruby? rsrs :shipit:

Sou muito mais a favor de usarmos algum gerador em NodeJS, menos 1 dependência, alias, menos um saco de dependência que é o Ruby :weary:

Dissertem.

maracaipe commented 10 years ago

Concordo com tudo que você disse. E a dúvida que não quer calar é: Como que o pessoal do GruntJS usa esses arquivos da documentação?

vitorbritto commented 10 years ago

Respondi anteriormente. Submodules. Pode ser com docpad ou hexo. Basta criar o submodule com o link para o git do repositorio.

Dessa forma, fica tudo sincronizado.