apache/sedona

Document how to build and change the documentation

Geschlossen

#1.727 geöffnet am 18.12.2024

Auf GitHub ansehenContributor Guide
 (10 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Scala (693 Forks)batch import
attention neededbugdocsgood first issuehelp wantedin progressquestion

Repository-Metriken

Stars
 (1.953 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 1T 3h) (35 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuchen Sie die vorhandene Dokumentations Build Einrichtung im Repository, wahrscheinlich im docs/ Verzeichnis. Suchen Sie nach Dateien wie Makefile, conf.py oder requirements.txt, um den Build Prozess zu verstehen. Schreiben Sie eine Schritt für Schritt Anleitung, die die Erstellung der virtuellen Umgebung, die Installation von Abhängigkeiten und den Build der Website abdeckt. Erwägen Sie, die Anweisungen in docs/README.md oder einer CONTRIBUTING.md Datei hinzuzufügen. Stellen Sie sicher, dass die Anleitung getestet ist und bei Bedarf plattformspezifische Tipps enthält.
Tech Stack
pythonshell
Domain
documentationdeveloper experience
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python virtual environmentbasic command line
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85