apache/sedona

Document how to build and change the documentation

Open

#1 727 ouverte le 18 déc. 2024

Voir sur GitHub
 (8 commentaires) (0 réactions) (0 assignés)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.

Guide contributeur

Stack technique
pythonshell
Domaine
documentationdeveloper experience
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Python virtual environmentbasic command line
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85
Direction de recherche
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.