You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by GitBox <gi...@apache.org> on 2022/06/03 14:13:01 UTC
[GitHub] [iceberg-docs] samredai commented on a diff in pull request #87: Update docs around how to prepare/release docs
samredai commented on code in PR #87:
URL: https://github.com/apache/iceberg-docs/pull/87#discussion_r888979284
##########
landing-page/content/common/how-to-release.md:
##########
@@ -264,33 +264,33 @@ 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.
+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. Note that all changes in `iceberg` need to happen against the `master` branch
+and changes in `iceberg-docs` need to happen against the `main` branch.
Adjust the commands accordingly if it is not the case.
#### iceberg repository preparations
A PR needs to be published in `iceberg` repository with the following changes:
-1. Mark the current latest release notes to past releases
-2. Update the latest artifact links in the release notes page
-3. Add release notes for the new release version
-2. Create new folder called `docs/versioned/releases/<VERSION NUMBER>` with a `_index.md` file. See the existing folders under `docs/versioned/releases` for more details.
+
+1. Create new folder called `docs/releases/<VERSION NUMBER>` with a `_index.md` file. See the existing folders under `docs/releases` for more details.
Review Comment:
grammar nit: `s/Create new/Create a new`
##########
landing-page/content/common/how-to-release.md:
##########
@@ -264,33 +264,33 @@ 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.
+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. Note that all changes in `iceberg` need to happen against the `master` branch
+and changes in `iceberg-docs` need to happen against the `main` branch.
Adjust the commands accordingly if it is not the case.
#### iceberg repository preparations
A PR needs to be published in `iceberg` repository with the following changes:
-1. Mark the current latest release notes to past releases
-2. Update the latest artifact links in the release notes page
-3. Add release notes for the new release version
-2. Create new folder called `docs/versioned/releases/<VERSION NUMBER>` with a `_index.md` file. See the existing folders under `docs/versioned/releases` for more details.
+
+1. Create new folder called `docs/releases/<VERSION NUMBER>` with a `_index.md` file. See the existing folders under `docs/releases` for more details.
#### iceberg-docs repository preparations
A PR needs to be published in `iceberg-docs` repository with the following changes:
Review Comment:
I know this line wasn't changed in this PR but I have a grammar nitpick here:
`s/published in/published in the`
##########
landing-page/content/common/how-to-release.md:
##########
@@ -301,7 +301,7 @@ In the `iceberg` repository, generate the javadoc for your release and copy it t
```shell
./gradlew refreshJavadoc
rm -rf ../iceberg-docs/javadoc
-cp site/docs/javadoc/<VERSION NUMBER> ../iceberg-docs/javadoc
+cp -r site/docs/javadoc/<VERSION NUMBER> ../iceberg-docs/javadoc
Review Comment:
Good catch!
##########
landing-page/content/common/how-to-release.md:
##########
@@ -264,33 +264,33 @@ 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.
+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. Note that all changes in `iceberg` need to happen against the `master` branch
+and changes in `iceberg-docs` need to happen against the `main` branch.
Adjust the commands accordingly if it is not the case.
#### iceberg repository preparations
A PR needs to be published in `iceberg` repository with the following changes:
-1. Mark the current latest release notes to past releases
-2. Update the latest artifact links in the release notes page
-3. Add release notes for the new release version
-2. Create new folder called `docs/versioned/releases/<VERSION NUMBER>` with a `_index.md` file. See the existing folders under `docs/versioned/releases` for more details.
+
+1. Create new folder called `docs/releases/<VERSION NUMBER>` with a `_index.md` file. See the existing folders under `docs/releases` for more details.
Review Comment:
grammar nit: `s/with a/with an`
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org