Skip to content

Commit ea47691

Browse files
committed
docs: adjust the changelog
Signed-off-by: spacewander <[email protected]>
1 parent 63becff commit ea47691

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

CHANGELOG.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,14 @@ title: Changelog
6464

6565
## 3.0.0-beta
6666

67+
Here we use 2.99.0 as the version number in the source code instead of the code name
68+
`3.0.0-beta` for two reasons:
69+
70+
1. avoid unexpected errors when some programs try to compare the
71+
version, as `3.0.0-beta` contains `3.0.0` and is longer than it.
72+
2. some package system might not allow package which has a suffix
73+
after the version number.
74+
6775
### Change
6876

6977
#### Moves the config_center, etcd and Admin API configuration to the deployment
@@ -90,10 +98,10 @@ With the new 3.0 release, we took the opportunity to clean out many configuratio
9098
In the static configuration, we removed several fields as follows:
9199

92100
- Removed `enable_http2` and `listen_port` from `apisix.ssl`: [#7717](https://github.com/apache/apisix/pull/7717)
93-
- Remove `apisix.port_admin`: [#7716](https://github.com/apache/apisix/pull/7716)
94-
- Remove `etcd.health_check_retry`: [#7676](https://github.com/apache/apisix/pull/7676)
95-
- Remove `nginx_config.http.lua_shared_dicts`: [#7677](https://github.com/apache/apisix/pull/7677)
96-
- Remove `nginx_config.http.real_ip_header`: [#7696](https://github.com/apache/apisix/pull/7696)
101+
- Removed `apisix.port_admin`: [#7716](https://github.com/apache/apisix/pull/7716)
102+
- Removed `etcd.health_check_retry`: [#7676](https://github.com/apache/apisix/pull/7676)
103+
- Removed `nginx_config.http.lua_shared_dicts`: [#7677](https://github.com/apache/apisix/pull/7677)
104+
- Removed `nginx_config.http.real_ip_header`: [#7696](https://github.com/apache/apisix/pull/7696)
97105

98106
In the dynamic configuration, we made the following adjustments:
99107

docs/zh/latest/CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,12 @@ title: CHANGELOG
6464

6565
## 3.0.0-beta
6666

67+
这里我们使用 `2.99.0` 作为源代码中的版本号,而不是代码名称
68+
`3.0.0-beta`,有两个原因。
69+
70+
1. 避免在一些程序试图比较版本时出现意外的错误,因为 `3.0.0-beta` 包含 `3.0.0` 并且比它长。
71+
2. 一些软件包系统可能不允许在版本号后面有一个后缀。
72+
6773
### Change
6874

6975
#### 移动 config_center、etcd 和 Admin API 的配置到 deployment 下面

0 commit comments

Comments
 (0)