-
Notifications
You must be signed in to change notification settings - Fork 96
Update docs around how to prepare/release docs #87
Update docs around how to prepare/release docs #87
Conversation
002819c to
186a416
Compare
samredai
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few small grammar nits but overall LGTM, Thank you @nastra!
186a416 to
c5a5b73
Compare
| 4. Update the latest artifact links in the release notes page in `landing-page/content/common/release-notes.md` | ||
| 5. Add release notes for the new release version in `landing-page/content/common/release-notes.md` | ||
|
|
||
| #### Documentation update |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know it's not part of this PR but I'm noticing that these instructions should actually come after the Cutting a new version branch section. These changes should then occur on that versioned branch. Here's the sequence that I think should be reflected here:
-
Clone your fork of apache/iceberg
-
Clone your fork of apache/iceberg-docs
-
Run
cp -r iceberg/format/* iceberg-docs/landing-page/content/common/ -
cd into the
iceberg-docsdirectory -
Create an
update-common-pagesbranch -
Commit, Push, and Open a PR against apache/iceberg-docs (
update-common-pages->main) -
Create a branch from
mainthat's named after the version (i.e.0.13.2). This must be done in the main repo, not in your fork. -
Fetch and checkout the version branch: i.e.
git fetch && git checkout 0.13.2 -
Copy the versioned docs in using
cp -r ../iceberg/docs ../iceberg-docs/docs/content/docs -
Change into the
icebergdirectory and generate the javadoccd ../iceberg && ./gradlew refreshJavadoc -
Copy the javadoc into the apache/iceberg-docs repo:
cp -r site/docs/javadoc/<VERSION NUMBER> ../iceberg-docs/javadoc -
Change into the
iceberg-docsdirectory, Commit, Push and Open a PR against the0.13.2branch in apache/iceberg-docs -
Checkout the main branch in apache/iceberg-docs
-
Create a branch
move-forward-latest-version -
Update variable
latestVersions.icebergto the new release version inlanding-page/config.toml -
Update variable
latestVersions.icebergto the new release version indocs/config.toml -
Mark the current latest release notes to past releases under
landing-page/content/common/release-notes.md -
Update the latest artifact links in the release notes page in
landing-page/content/common/release-notes.md -
Add release notes for the new release version in
landing-page/content/common/release-notes.md -
Commit, Push, and Open a PR against apache/iceberg-docs (
move-forward-latest-version->main)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nastra I've opened a PR against your fork to update this to represent the flow listed above. Please take a look when you have a chance and let me know what you think.
The general ordering requires that the common pages are updated and merged and then a version branch has to be cut immediately. Everything after that (adding versioned docs & adding javadocs), then happens against that version branch.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks @samredai, approved and merged it
bbfdd54 to
a49da78
Compare
a49da78 to
4ea18e8
Compare
No description provided.