jackye1995 commented on a change in pull request #4105:
URL: https://github.com/apache/iceberg/pull/4105#discussion_r806320932
##########
File path: docs/common/project/how-to-release.md
##########
@@ -255,3 +260,63 @@ Java artifacts are available from Maven Central.
Thanks to everyone for contributing!
```
+
+### Documentation Release
+
+Documentation needs to be updated as a part of Iceberg release after a release
candidate is passed.
+The commands described below assume the `iceberg-docs` repository and
`iceberg` repository are in the same parent directory locally,
+and the release manager is executing commands in the `iceberg` repository.
+Adjust the commands accordingly if it is not the case.
+
+#### Release notes
+
+Release notes need to be drafted and published in the `iceberg` repository and
reviewed by the community.
+
+#### Iceberg version update
+
+Before release, publish a PR in the `iceberg-docs` repository to update
`landing-page/config.toml` and `docs/config.toml` to use the new Iceberg
version number.
+
+#### Documentation update
+
+To start the release process, run the following steps in the `iceberg-docs`
repository to copy docs over:
+
+```shell
+rm -rf ../iceberg-docs/docs/content/docs
+rm -rf ../iceberg-docs/landing-page/content/common
+cp -r docs/versioned ../iceberg-docs/docs/content/docs
+cp -r docs/common ../iceberg-docs/landing-page/content/common
Review comment:
If we just have `spec.md` in `common`, we just remove that specific file
and copy that file instead of the entire `common` folder.
##########
File path: docs/common/project/how-to-release.md
##########
@@ -255,3 +260,63 @@ Java artifacts are available from Maven Central.
Thanks to everyone for contributing!
```
+
+### Documentation Release
+
+Documentation needs to be updated as a part of Iceberg release after a release
candidate is passed.
+The commands described below assume the `iceberg-docs` repository and
`iceberg` repository are in the same parent directory locally,
+and the release manager is executing commands in the `iceberg` repository.
+Adjust the commands accordingly if it is not the case.
+
+#### Release notes
+
+Release notes need to be drafted and published in the `iceberg` repository and
reviewed by the community.
+
+#### Iceberg version update
+
+Before release, publish a PR in the `iceberg-docs` repository to update
`landing-page/config.toml` and `docs/config.toml` to use the new Iceberg
version number.
+
+#### Documentation update
+
+To start the release process, run the following steps in the `iceberg-docs`
repository to copy docs over:
+
+```shell
+rm -rf ../iceberg-docs/docs/content/docs
+rm -rf ../iceberg-docs/landing-page/content/common
+cp -r docs/versioned ../iceberg-docs/docs/content/docs
+cp -r docs/common ../iceberg-docs/landing-page/content/common
+```
+
+The resulted changes in `iceberg-docs` should be approved in a separated PR.
Review comment:
updated
--
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]