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

Quick notes how to update docs and javadoc at release publication time. #10810

Closed
wants to merge 1 commit into from

Conversation

jbonofre
Copy link
Member

No description provided.

@jbonofre jbonofre requested a review from Fokko July 29, 2024 15:15
@github-actions github-actions bot added the docs label Jul 29, 2024
@@ -270,6 +270,46 @@ git tag -am 'Release Apache Iceberg <VERSION>' apache-iceberg-<VERSION> apache-i

Then release the candidate repository in [Nexus](https://repository.apache.org/#stagingRepositories).

#### Update docs and javadoc for the release
Copy link
Member

Choose a reason for hiding this comment

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

There is already a section called "### Documentation Release" can we move it under that?
It points to a readme and maybe we should update these steps in that readme.

Copy link
Member Author

Choose a reason for hiding this comment

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

Reason I put here is because imho, it should be part of the release publication and should be mentioned as part of the release process.
No problem to update, but release manager has to go there (which is not obvious imho).

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree with Ajantha that it looks like there are two sections about docs:

https://github.com/apache/iceberg/blob/47220768d16b9e3b43af48c0e0d92b30aba43c09/site/docs/how-to-release.md#documentation-release

The one that's already there doesn't add much value since the publication steps are not in there

Copy link
Member Author

Choose a reason for hiding this comment

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

@ajantha-bhat resuming this PR: I guess you are proposing to move update docs and javadoc in the documentation-release section right ?

Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can even move these info in the README pointed out in that section.

We just need all docs related stuffs in one place.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree, let me rework this. Thanks.

@Fokko Fokko requested a review from bitsondatadev July 29, 2024 18:29
Copy link

This pull request has been marked as stale due to 30 days of inactivity. It will be closed in 1 week if no further activity occurs. If you think that’s incorrect or this pull request requires a review, please simply write any comment. If closed, you can revive the PR at any time and @mention a reviewer or discuss it on the dev@iceberg.apache.org list. Thank you for your contributions.

@github-actions github-actions bot added the stale label Nov 24, 2024
Copy link

github-actions bot commented Dec 1, 2024

This pull request has been closed due to lack of activity. This is not a judgement on the merit of the PR in any way. It is just a way of keeping the PR queue manageable. If you think that is incorrect, or the pull request requires review, you can revive the PR at any time.

@github-actions github-actions bot closed this Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants