apache/sedona

Document how to build and change the documentation

Open

#1.727 aberto em 18 de dez. de 2024

Ver no GitHub
 (8 comments) (0 reactions) (0 assignees)Scala (1.953 stars) (693 forks)batch import
attention neededbugdocsgood first issuehelp wantedin progressquestion

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

Pilha de tecnologia
pythonshell
Domain
documentationdeveloper experience
Tipo Issue
documentation
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 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
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
Direção de pesquisa
Examine the existing documentation build setup in the repository, likely in the docs/ directory. Look for files like Makefile, conf.py, or requirements.txt to understand the build process. Write a step by step guide covering virtual environment creation, dependency installation, and building the site. Consider adding the instructions to docs/README.md or a CONTRIBUTING.md file. Ensure the guide is tested and includes any platform specific tips if necessary.