apache/sedona

Document how to build and change the documentation

Open

#1727 opened on Dec 18, 2024

View on 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.

Contributor guide

Tech stack
pythonshell
Domain
documentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python virtual environmentbasic command line
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
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.