StackGuardian/tirith

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

Aberta

#200 aberto em 22 de out. de 2024

Ver no GitHubGuia do colaborador
 (2 comentários) (0 reação) (1 responsável)Python (41 forks)auto 404
enhancementhacktoberfest

Métricas do repositório

Stars
 (168 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Crie um arquivo de fluxo de trabalho do GitHub Actions (.github/workflows/docs deploy.yml) que seja acionado ao enviar para main ou ao mesclar um PR que afete docs/. Inclua uma etapa de verificação ortográfica usando uma ferramenta como pyspelling ou codespell, e implante a documentação no GitHub Pages usando peaceiris/actions gh pages. Certifique se de que o fluxo de trabalho seja bem documentado e fácil de seguir.
Pilha de tecnologia
pythongithub actions
Domain
documentationdevops
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitGitHub Actions basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85