You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/09/06 04:15:37 UTC

[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #17130: [fix][doc] Sync recent changes on versioned docs

Anonymitaet commented on code in PR #17130:
URL: https://github.com/apache/pulsar/pull/17130#discussion_r963235581


##########
wiki/release/release-process.md:
##########
@@ -521,21 +523,11 @@ After you run this command, a new folder `version-<release-version>` is added in
 
 9. Generate the doc set and sidebar file for the next minor release `2.X.1` based on the `site2/docs` folder. You can follow step 1, 2, 3 and submit those files to apache/pulsar repository. This step is a preparation for `2.X.1` release.
 
-### Update the site for minor releases
-
-The new updates for the minor release docs are processed in its doc set and sidebar file directly before release. You can follow step 4~8 (in major release) to update the site. You'll also need to add this new version to `versions.json`.
-
-To make preparation for the next minor release, you need to generate the doc set and sidebar file based on the previous release. Take `2.X.2` as example, `2.X.2` doc set and sidebar.json file are generated based on `2.X.1`. You can make it with the following steps:
-
-1. Copy the `version-2.X.1` doc set and `version-2.X.1-sidebars.json` file and rename them as `version-2.X.2` doc set and `version-2.X.2-sidebars.json` file.
-
-2. Update the "id" from `version-2.X.1` to `version-2.X.2` for the md files in the `version-2.X.2` doc set and `version-2.X.2-sidebars.json` file.
+:::note

Review Comment:
   ```suggestion
   > **Note**
   ```
   This is a .md file



##########
wiki/release/release-process.md:
##########
@@ -521,21 +523,11 @@ After you run this command, a new folder `version-<release-version>` is added in
 
 9. Generate the doc set and sidebar file for the next minor release `2.X.1` based on the `site2/docs` folder. You can follow step 1, 2, 3 and submit those files to apache/pulsar repository. This step is a preparation for `2.X.1` release.
 
-### Update the site for minor releases
-
-The new updates for the minor release docs are processed in its doc set and sidebar file directly before release. You can follow step 4~8 (in major release) to update the site. You'll also need to add this new version to `versions.json`.
-
-To make preparation for the next minor release, you need to generate the doc set and sidebar file based on the previous release. Take `2.X.2` as example, `2.X.2` doc set and sidebar.json file are generated based on `2.X.1`. You can make it with the following steps:
-
-1. Copy the `version-2.X.1` doc set and `version-2.X.1-sidebars.json` file and rename them as `version-2.X.2` doc set and `version-2.X.2-sidebars.json` file.
-
-2. Update the "id" from `version-2.X.1` to `version-2.X.2` for the md files in the `version-2.X.2` doc set and `version-2.X.2-sidebars.json` file.
+:::note
 
-3. Submit the new doc set and sidebar.json file to the apache/pulsar repository.
+Starting from 2.8, you don't need to generate the doc set or update the Pulsar site for bug-fix releases, such as 2.8.1, 2.8.2 and so on. The generic doc set 2.8.x is used.
 
-> **Note**
-> - The `yarn run version <release-version>` command generates the new doc set and sidebar.json file based on the `site2/docs` folder.
-> - The minor release doc is generated based on the previous minor release (e.g.: `2.X.2` doc is generated based on `2.X.1`, and `2.X.3`doc is generated based on `2.X.2`), so you cannot use the `yarn run version <release-version>` command directly.
+:::

Review Comment:
   ```suggestion
   
   ```



##########
wiki/release/release-process.md:
##########
@@ -521,21 +523,11 @@ After you run this command, a new folder `version-<release-version>` is added in
 
 9. Generate the doc set and sidebar file for the next minor release `2.X.1` based on the `site2/docs` folder. You can follow step 1, 2, 3 and submit those files to apache/pulsar repository. This step is a preparation for `2.X.1` release.
 
-### Update the site for minor releases
-
-The new updates for the minor release docs are processed in its doc set and sidebar file directly before release. You can follow step 4~8 (in major release) to update the site. You'll also need to add this new version to `versions.json`.
-
-To make preparation for the next minor release, you need to generate the doc set and sidebar file based on the previous release. Take `2.X.2` as example, `2.X.2` doc set and sidebar.json file are generated based on `2.X.1`. You can make it with the following steps:
-
-1. Copy the `version-2.X.1` doc set and `version-2.X.1-sidebars.json` file and rename them as `version-2.X.2` doc set and `version-2.X.2-sidebars.json` file.
-
-2. Update the "id" from `version-2.X.1` to `version-2.X.2` for the md files in the `version-2.X.2` doc set and `version-2.X.2-sidebars.json` file.
+:::note
 
-3. Submit the new doc set and sidebar.json file to the apache/pulsar repository.
+Starting from 2.8, you don't need to generate the doc set or update the Pulsar site for bug-fix releases, such as 2.8.1, 2.8.2 and so on. The generic doc set 2.8.x is used.

Review Comment:
   ```suggestion
   > Starting from 2.8, you don't need to generate an independent doc set for each release or update the Pulsar site for bug-fix releases, such as 2.8.1, 2.8.2, and so on. The generic doc set 2.8.x is used.
   ```



-- 
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: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org