Skip to content
This repository has been archived by the owner on Oct 27, 2022. It is now read-only.

Criar github-pages para documentação do projeto #24

Closed
3 tasks done
Bumbleblo opened this issue Mar 28, 2019 · 5 comments
Closed
3 tasks done

Criar github-pages para documentação do projeto #24

Bumbleblo opened this issue Mar 28, 2019 · 5 comments
Assignees
@Bumbleblo
Labels
documentation enhancement New feature or request
Milestone
Sprint 1

Comments

@Bumbleblo
Copy link
Contributor

Bumbleblo commented Mar 28, 2019 •
edited

Descrição

Criar site estático para armazenar a documentação do projeto

Tarefas

  • Escolher uma tecnologia para a web page estática
  • Realizar o deploy no github-pages
  • Escrever um manual para publicação de novos artigos

Informação adicional

Olhem no githb pages
@Bumbleblo Bumbleblo added this to the Sprint 1 milestone Mar 28, 2019
@Bumbleblo Bumbleblo self-assigned this Mar 28, 2019
@Bumbleblo Bumbleblo added documentation enhancement New feature or request labels Mar 28, 2019
@Bumbleblo
Copy link
Contributor Author

Por questões de habilidade tecnologia do time vamos utilizar o framework Pelican

@Bumbleblo
Copy link
Contributor Author

Estou usando esse post como referência além do quick start do Pelican.

Bumbleblo added a commit that referenced this issue Mar 28, 2019
@Bumbleblo
#24 - Initial version of Pelican site with docker-compose tools
7f15da9 
Signed-off-by: bumbleblo <bumbleblo2013@gmail.com>
@Bumbleblo
Copy link
Contributor Author

Escrevi dois serviços do docker-compose para automatizar o processo de build e de debug do site:

  • build_pages: Realiza a compilação do site
  • serve: sobe o servidor Pelican realizando um bind na porta 8000

@Bumbleblo
Copy link
Contributor Author

Existe um problema no carregamento do css em homologação. Já resolvi esse problema uma vez apenas configurando o SITEURL no arquivo publishconf.py. Vou analisar mais a fundo para resolver este problema.

Bumbleblo added a commit that referenced this issue Mar 28, 2019
@Bumbleblo
#24 - Adding a contributing guide for github-pages
ca7cf94 
Signed-off-by: bumbleblo <bumbleblo2013@gmail.com>
@Bumbleblo
Copy link
Contributor Author

O problema foi resolvido apenas configurando corretamente o SITEURL, o manual de contribuição está no README.md na branch gh-pages.

Bumbleblo added a commit that referenced this issue Mar 29, 2019
@Bumbleblo
#24 - Improving docker-compose script and adding more scenarios
1cb3c17 
Signed-off-by: bumbleblo <bumbleblo2013@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@Bumbleblo Bumbleblo

Labels
documentation enhancement New feature or request
Projects
None yet
Milestone
Sprint 1
Development

No branches or pull requests
2 participants
@Bumbleblo @joaorobson