Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] add docs about nightly build #1670

Merged
merged 4 commits into from
Feb 17, 2025

Conversation

kevinjqliu
Copy link
Contributor

@kevinjqliu kevinjqliu commented Feb 17, 2025

Nightly testpypi build was added in #1601
This PR adds a subpage under "Releases" about the nightly build.

Running make docs-serve locally,
Screenshot 2025-02-17 at 9 24 59 AM

@kevinjqliu kevinjqliu requested a review from Fokko February 17, 2025 01:55

# Nightly Build

A nightly build of PyIceberg is available on testpypi, [https://test.pypi.org/project/pyiceberg/](https://test.pypi.org/project/pyiceberg/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a line to make it explicit that it is only for testing purposes, see release-policy. I would also include a warning that it hasn't been validated, so there is also a risk of using this (both legal issues with licenses, and potential bugs).

@Fokko
Copy link
Contributor

Fokko commented Feb 17, 2025

Thanks for adding this @kevinjqliu 🙌

kevinjqliu and others added 2 commits February 17, 2025 12:12
Co-authored-by: Fokko Driesprong <fokko@apache.org>
@kevinjqliu kevinjqliu requested a review from Fokko February 17, 2025 17:30
@kevinjqliu
Copy link
Contributor Author

thanks for the review @Fokko
updated the wording and the screenshot above

Copy link
Contributor

@Fokko Fokko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks beautiful, thanks for adding the warning 👍

@kevinjqliu kevinjqliu merged commit 7200a92 into apache:main Feb 17, 2025
3 checks passed
@kevinjqliu kevinjqliu deleted the kevinjqliu/nightly-build-doc branch February 17, 2025 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants