yiaany commented on issue #17071: URL: https://github.com/apache/datafusion/issues/17071#issuecomment-5426173841
Hi! I'd like to work on this. I reviewed the approaches discussed above, including DataFusion Comet's multi-version build, Apache Arrow's release documentation publishing process and the version selector supported by `pydata_sphinx_theme`. Based on the maintainer feedback, I propose starting with a minimal first milestone: - keep the current `main` documentation available as the development version; - build and publish documentation for DataFusion `55.0.0`; - define stable URLs for development and released documentation; - add a version selector backed by a generated or maintained versions JSON file; - ensure links, static assets and canonical metadata work correctly from versioned paths; - document the local build and publication process; - add CI validation for the version manifest and generated documentation; - avoid backfilling older versions until the first release workflow has been reviewed. After that foundation is accepted, follow-up work could: - integrate documentation publication into the release process; - backfill selected previous releases; - define retention and “latest” alias behavior; - verify search behavior across development and released versions. Before implementing the full workflow, I can open a small proposal or draft PR that documents: 1. the public URL structure; 2. the generated directory layout; 3. the version manifest format; 4. how `main`, `latest` and numbered releases are represented; 5. which parts run on normal documentation builds versus release publication. A few details I would like to confirm: - Should `https://datafusion.apache.org/` continue to show `main`, or should it eventually resolve to the latest released documentation? - Is `55.0.0` the preferred first version for the proof of concept? - Should the first PR publish a manually generated `55.0.0` snapshot, with release automation handled separately? - Is there a preferred URL convention, such as `/55.0.0/`, `/version/55.0.0/` or another structure? If this scope matches the intended direction, could the issue be assigned to me? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
