Viewing rendered docs from a PR to check

Ouverte
#363 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
32/100
Type d'issue
Fonctionnalité
Clarté
À clarifier
Activité
À l'abandon
Stack technique
github-actions
Domaine
ci-cd, documentation

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
Python
Étoiles
62
Forks
10
Merge moyen
7 j 6 h
PR mergées (30 j)
6

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de UCL-ARC/python-tooling

Toutes les issues de UCL-ARC/python-tooling

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.