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

Dificuldade para publicar documentação online utilizando github pages #19

Closed
1 of 3 tasks
gabrielbdornas opened this issue Jun 2, 2021 · 2 comments
Closed
1 of 3 tasks

Comments

@gabrielbdornas
Copy link
Contributor

gabrielbdornas commented Jun 2, 2021

Os primeiros testes para publicação da documentação online do projeto utilizando github pages não foi bem sucedida. Basicamente a documentação fica disponível, mas perde o estilo, muito similar ao relatado neste stackoverflow post.

Minha suspeita original, a partir do posto citado acima e deste outro é dificuldade enfrentada pela ferramenta de ler "relative_permalinks", como também levantado na própria documentação

Relative permalinks configured
This errors means that you have relative permalinks, which are not supported by GitHub Pages, in your _config.yml file.

Permalinks are permanent URLs that reference a particular page on your site. Absolute permalinks begin with the root of the >site, while relative permalinks begin with the folder containing the referenced page. GitHub Pages and Jekyll no longer support >relative permalinks. For more information about permalinks, see "Permalinks" in the Jekyll documentation.

To troubleshoot, remove the relative_permalinks line from your _config.yml file and reformat any relative permalinks in your site >with absolute permalinks. For more information, see "Editing files in your repository."

Realizar testes modificando as tags de estilo do arquivo index.html para referenciar os arquivos deste a raiz do projeto e não o caminho relativo ao próprio arquivo index.html

A publicação na ferramenta ReadTheDocs, funcionou perfeitamente. Sendo assim publicarei nela, tendo em vista que o objetivo principal é ter a documentação do projeto publicado online, não se importando qual a ferramenta deverá ser utilizada. Uma outra vantagem na utilização desta ferramenta é a facilidade de publicação, não sendo necessário modificar nada no código, exigências presentes na publicação via github pages.

Encaminhamentos para finaizar o issue:

  • Criar uma conta ReadTheDocs para o email [email protected]
  • Validar a conta criada a conta guithub/dados-mg para publicação da documentação (apresentando erro na primeira tentativa, conforme print abaixo:)
    Screenshot from 2021-06-02 16-06-59
  • Publicar documentação online após merge do PR 18

@fjuniorr, em algum outro momento o e-mail [email protected] foi utilizado para criação de conta na ReadTheDocs?

@fjuniorr
Copy link
Contributor

fjuniorr commented Jun 7, 2021

@fjuniorr, em algum outro momento o e-mail [email protected] foi utilizado para criação de conta na ReadTheDocs?

Acho que não @gabrielbdornas.

Alguns emails foram pro caixa de spam dessa conta no dia 02/06. Marquei como não spam mas não cliquei no link de ativação (vou deixar vc fazer isso porque fica mais fácil testar se deu certo).

Caixa_de_Entrada_•_dadosabertos_cge_mg_gov_br

@gabrielbdornas
Copy link
Contributor Author

Documentação publicada aqui

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants