Skip to content

Commit

Permalink
docs: adjust the changelog
Browse files Browse the repository at this point in the history
Signed-off-by: spacewander <[email protected]>
  • Loading branch information
spacewander committed Sep 25, 2022
1 parent 63becff commit ea47691
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
16 changes: 12 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,14 @@ title: Changelog

## 3.0.0-beta

Here we use 2.99.0 as the version number in the source code instead of the code name
`3.0.0-beta` for two reasons:

1. avoid unexpected errors when some programs try to compare the
version, as `3.0.0-beta` contains `3.0.0` and is longer than it.
2. some package system might not allow package which has a suffix
after the version number.

### Change

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

- Removed `enable_http2` and `listen_port` from `apisix.ssl`: [#7717](https://github.com/apache/apisix/pull/7717)
- Remove `apisix.port_admin`: [#7716](https://github.com/apache/apisix/pull/7716)
- Remove `etcd.health_check_retry`: [#7676](https://github.com/apache/apisix/pull/7676)
- Remove `nginx_config.http.lua_shared_dicts`: [#7677](https://github.com/apache/apisix/pull/7677)
- Remove `nginx_config.http.real_ip_header`: [#7696](https://github.com/apache/apisix/pull/7696)
- Removed `apisix.port_admin`: [#7716](https://github.com/apache/apisix/pull/7716)
- Removed `etcd.health_check_retry`: [#7676](https://github.com/apache/apisix/pull/7676)
- Removed `nginx_config.http.lua_shared_dicts`: [#7677](https://github.com/apache/apisix/pull/7677)
- Removed `nginx_config.http.real_ip_header`: [#7696](https://github.com/apache/apisix/pull/7696)

In the dynamic configuration, we made the following adjustments:

Expand Down
6 changes: 6 additions & 0 deletions docs/zh/latest/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,12 @@ title: CHANGELOG

## 3.0.0-beta

这里我们使用 `2.99.0` 作为源代码中的版本号,而不是代码名称
`3.0.0-beta`,有两个原因。

1. 避免在一些程序试图比较版本时出现意外的错误,因为 `3.0.0-beta` 包含 `3.0.0` 并且比它长。
2. 一些软件包系统可能不允许在版本号后面有一个后缀。

### Change

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

0 comments on commit ea47691

Please sign in to comment.