StackGuardian/tirith

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

开放

#200 创建于 2024年10月22日

在 GitHub 查看贡献者指南
 (2 条评论) (0 个反应) (1 位负责人)Python (41 个派生)auto 404
enhancementhacktoberfest

仓库指标

星标
 (168 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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.

贡献者指南

研究方向
创建一个 GitHub Actions 工作流文件 (.github/workflows/docs deploy.yml)，当推送到 main 或影响 docs/ 的 PR 合并时触发。包含一个拼写检查步骤，使用 pyspelling 或 codespell 等工具，并使用 peaceiris/actions gh pages 将文档部署到 GitHub Pages。确保工作流文档齐全且易于遵循。
技术栈
pythongithub actions
领域
documentationdevops
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GitGitHub Actions basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85