StackGuardian/tirith

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

Offen

#200 geöffnet am 22.10.2024

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (41 Forks)auto 404
enhancementhacktoberfest

Repository-Metriken

Stars
 (168 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Erstellen Sie eine GitHub Actions Workflow Datei (.github/workflows/docs deploy.yml), die bei Push auf main oder bei Merge eines PR, der docs/ betrifft, ausgelöst wird. Fügen Sie einen Rechtschreibprüfungsschritt mit einem Tool wie pyspelling oder codespell hinzu und stellen Sie die Dokumentation mit peaceiris/actions gh pages auf GitHub Pages bereit. Stellen Sie sicher, dass der Workflow gut dokumentiert und leicht nachvollziehbar ist.
Tech Stack
pythongithub actions
Domain
documentationdevops
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitGitHub Actions basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85