apache/sedona

Document how to build and change the documentation

Fechada

#1.727 aberto em 18 de dez. de 2024

Ver no GitHubGuia do colaborador
 (10 comentários) (0 reação) (1 responsável)Scala (693 forks)batch import
attention neededbugdocsgood first issuehelp wantedin progressquestion

Métricas do repositório

Stars
 (1.953 estrelas)
Métricas de merge de PR
 (Mesclagem média 1d 3h) (35 fundiu PRs em 30d)

Description

Expected behavior: Setup instructions on how to build the documentation locally.

Actual behavior: User has to figure out how to build the documentation site locally (it's not hard, but would be easier with instructions).

Suggested change: explain how the user can build a virtual environment with the required dependencies and add contribution instructions on how to build the documentation site locally.

Guia do colaborador

Direção de pesquisa
Examine a configuração de construção de documentação existente no repositório, provavelmente no diretório docs/. Procure arquivos como Makefile, conf.py ou requirements.txt para entender o processo de construção. Escreva um guia passo a passo que cubra a criação do ambiente virtual, instalação de dependências e construção do site. Considere adicionar as instruções ao docs/README.md ou a um arquivo CONTRIBUTING.md. Certifique se de que o guia seja testado e inclua quaisquer dicas específicas da plataforma, se necessário.
Pilha de tecnologia
pythonshell
Domain
documentationdeveloper experience
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
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.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python virtual environmentbasic command line
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85