StackGuardian/tirith

[DOCUMENTATION] - Create a GitHub actions workflow to deploy docs to GitHub pages

Ouverte

#200 ouverte le 22 oct. 2024

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (1 personne assignée)Python (41 forks)auto 404
enhancementhacktoberfest

Métriques du dépôt

Stars
 (168 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

Description

I would create a GitHub actions workflow to deploy the documentation to the GitHub pages (or if you have any other platform, please suggest).

  1. The workflow will get triggered automatically as soon as any PR related to the docs is merged
  2. The workflow will also have a spell check so that if you raise a PR and the doc has some spelling mistakes, the workflow will throw an error, so it solves the manual check of spelling every time.

Hey @refeed feel free to add more such conditions if you want to.

Guide contributeur

Direction de recherche
Créez un fichier de workflow GitHub Actions (.github/workflows/docs deploy.yml) qui se déclenche lors d'un push sur main ou d'un merge d'une PR affectant docs/. Incluez une étape de vérification orthographique à l'aide d'un outil comme pyspelling ou codespell, et déployez la documentation sur GitHub Pages en utilisant peaceiris/actions gh pages. Assurez vous que le workflow est bien documenté et facile à suivre.
Stack technique
pythongithub actions
Domaine
documentationdevops
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitGitHub Actions basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85