apache/sedona

Document how to build and change the documentation

Open

Aperta il 18 dic 2024

Vedi su GitHub
 (8 commenti) (0 reazioni) (0 assegnatari)Scala (1953 star) (693 fork)batch import
attention neededbugdocsgood first issuehelp wantedin progressquestion

Descrizione

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.

Guida contributor

Tech stack
pythonshell
Dominio
documentationdeveloper experience
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Python virtual environmentbasic command line
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85
Direzione di ricerca
Esamina la configurazione di compilazione della documentazione esistente nel repository, probabilmente nella directory docs/. Cerca file come Makefile, conf.py o requirements.txt per comprendere il processo di compilazione. Scrivi una guida passo passo che copra la creazione dell'ambiente virtuale, l'installazione delle dipendenze e la compilazione del sito. Considera di aggiungere le istruzioni a docs/README.md o a un file CONTRIBUTING.md. Assicurati che la guida sia testata e includa eventuali suggerimenti specifici per piattaforma, se necessario.