StackGuardian/tirith

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

Aperta

#200 aperta il 22 ott 2024

Vedi su GitHubGuida contributor
 (2 commenti) (0 reazioni) (1 assegnatario)Python (41 fork)auto 404
enhancementhacktoberfest

Metriche repository

Star
 (168 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Crea un file di workflow di GitHub Actions (.github/workflows/docs deploy.yml) che si attivi al push su main o al merge di una PR che interessa docs/. Includi un passaggio di controllo ortografico utilizzando uno strumento come pyspelling o codespell, e distribuisci la documentazione su GitHub Pages utilizzando peaceiris/actions gh pages. Assicurati che il workflow sia ben documentato e facile da seguire.
Tech stack
pythongithub actions
Dominio
documentationdevops
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitGitHub Actions basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85