Viewing rendered docs from a PR to check

Abierto
#363 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
32/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
github-actions
Área
ci-cd, documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Python
Estrellas
62
Forks
10
Merge medio
7 d 6 h
PR fusionados (30 d)
6

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de UCL-ARC/python-tooling

Todos los issues de UCL-ARC/python-tooling

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.