Viewing rendered docs from a PR to check

Aberta
#363 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
32/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
github-actions
Domínio
ci-cd, documentation

Direção de pesquisa

Review the referenced .github/workflows/docs.yml in the Excalibur repository to understand the proposed rendered-docs workflow, then inspect this repository’s documentation and CI configuration. Done means a pull request can render the documentation for checking before merge.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

enhancement

We don't have any way of viewing rendered docs from a PR to check them before merging do we?

For what is worth, we do that in the excalibur benchmarking repository: https://github.com/ukri-excalibur/excalibur-tests/blob/ede38fa104eed72557233cbfc76b230727973791/.github/workflows/docs.yml (this is using mkdocs rather than jekyll, but to give an idea of what one can do to accomplish that).

Originally posted by @giordano in https://github.com/UCL-ARC/python-tooling/issues/358#issuecomment-2077433013

Linguagem predominante
Python
Estrelas
62
Forks
10
Merge médio
5d 19h
PRs com merge (30d)
6

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de UCL-ARC/python-tooling

Todas as issues de UCL-ARC/python-tooling

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.