mishop-15
a257c29c26
## Which issue does this PR close? - Closes #20572 ## Rationale for this change When upgrade guides were split into separate pages (#20183), the old `upgrading.html` URL broke. All changelog files still reference this old URL, causing 404 errors for users. ## What changes are included in this PR? Added a redirect in `docs/source/conf.py` using the existing `sphinx_reredirects` extension to redirect `library-user-guide/upgrading.html` to `library-user-guide/upgrading/index.html`. This preserves all existing changelog links without needing to update historical files. ## Are these changes tested? Tested locally - the redirect works correctly, including with anchor links (e.g., `upgrading.html#datafusion-46-0-0`). ## Are there any user-facing changes? Yes - users clicking old changelog links will now be redirected to the correct page instead of getting a 404.
DataFusion Documentation
This folder contains the source content of the User Guide and Contributor Guide. These are both published to https://datafusion.apache.org/ as part of the release process.
Dependencies
Install build dependencies and build the documentation using uv:
uv sync
uv run bash build.sh
The docs build regenerates the workspace dependency graph via
docs/scripts/generate_dependency_graph.sh, so ensure cargo, cargo-depgraph
(cargo install cargo-depgraph --version ^1.6 --locked), and Graphviz dot
(brew install graphviz or sudo apt-get install -y graphviz) are available.
Build & Preview
Run the provided script to build the HTML pages.
# If using venv, ensure you have activated it
./build.sh
The HTML will be generated into a build directory. Open build/html/index.html
in your preferred browser, e.g.
Preview the site on Linux by running this command.
# On macOS
open build/html/index.html
# On Linux with Firefox
firefox build/html/index.html
Making Changes
To make changes to the docs, simply make a Pull Request with your proposed changes as normal. When the PR is merged the docs will be automatically updated.
Release Process
This documentation is hosted at https://datafusion.apache.org/
When the PR is merged to the main branch of the DataFusion
repository, a github workflow which:
- Builds the html content
- Pushes the html content to the
asf-sitebranch in this repository.
The Apache Software Foundation provides https://datafusion.apache.org/, which serves content based on the configuration in .asf.yaml, which specifies the target as https://datafusion.apache.org/.