This is an automated email from the ASF dual-hosted git repository.
shoothzj pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git
The following commit(s) were added to refs/heads/master by this push:
new e2e8f34aae doc: update documentation for releases and APIs to reflect
correct versions (#4365)
e2e8f34aae is described below
commit e2e8f34aaef47c576bfbca356e2f7472195ae451
Author: ZhangJian He <[email protected]>
AuthorDate: Thu May 16 15:10:26 2024 +0800
doc: update documentation for releases and APIs to reflect correct versions
(#4365)
### Changes
- Fix some versions wrong in the version docs.
- Cherry-Pick the removal of twitter metrics library to 4.17.0 doc
- Update the `latest_release` and `stable_release `
Signed-off-by: ZhangJian He <[email protected]>
---
site3/website/docusaurus.config.js | 4 ++--
.../version-4.15.5/overview/overview.md | 2 +-
.../versioned_docs/version-4.17.0/api/ledger-api.md | 8 ++++----
.../version-4.17.0/overview/overview.md | 6 +++---
.../versioned_docs/version-4.17.0/reference/config.md | 19 +------------------
5 files changed, 11 insertions(+), 28 deletions(-)
diff --git a/site3/website/docusaurus.config.js
b/site3/website/docusaurus.config.js
index c001c3ef29..e40ba55053 100644
--- a/site3/website/docusaurus.config.js
+++ b/site3/website/docusaurus.config.js
@@ -7,8 +7,8 @@ const baseUrl = process.env.BASE_URL || "/"
const deployUrl = process.env.DEPLOY_URL || "https://bookkeeper.apache.org";;
const variables = {
/** They are used in .md files*/
- latest_release: "4.16.4",
- stable_release: "4.14.8",
+ latest_release: "4.17.0",
+ stable_release: "4.16.5",
github_repo: "https://github.com/apache/bookkeeper";,
github_master: "https://github.com/apache/bookkeeper/tree/master";,
mirror_base_url: "https://www.apache.org/dyn/closer.lua/bookkeeper";,
diff --git a/site3/website/versioned_docs/version-4.15.5/overview/overview.md
b/site3/website/versioned_docs/version-4.15.5/overview/overview.md
index 6b4ac18c22..ae2fd5e79c 100644
--- a/site3/website/versioned_docs/version-4.15.5/overview/overview.md
+++ b/site3/website/versioned_docs/version-4.15.5/overview/overview.md
@@ -21,7 +21,7 @@ specific language governing permissions and limitations
under the License.
-->
-This documentation is for Apache BookKeeper™ version {{
site.latest_release }}.
+This documentation is for Apache BookKeeper™ version 4.15.5.
Apache BookKeeper™ is a scalable, fault-tolerant, low-latency storage
service optimized for real-time workloads. It offers durability, replication,
and strong consistency as essentials for building reliable real-time
applications.
diff --git a/site3/website/versioned_docs/version-4.17.0/api/ledger-api.md
b/site3/website/versioned_docs/version-4.17.0/api/ledger-api.md
index 7160c9e0b8..f6ba283825 100644
--- a/site3/website/versioned_docs/version-4.17.0/api/ledger-api.md
+++ b/site3/website/versioned_docs/version-4.17.0/api/ledger-api.md
@@ -21,7 +21,7 @@ If you're using [Maven](https://maven.apache.org/), add this
to your [`pom.xml`]
```xml
<!-- in your <properties> block -->
-<bookkeeper.version>4.16.4</bookkeeper.version>
+<bookkeeper.version>4.17.0</bookkeeper.version>
<!-- in your <dependencies> block -->
<dependency>
@@ -37,7 +37,7 @@ shaded library, which relocate classes of protobuf and guava
into a different na
```xml
<!-- in your <properties> block -->
-<bookkeeper.version>4.16.4</bookkeeper.version>
+<bookkeeper.version>4.17.0</bookkeeper.version>
<!-- in your <dependencies> block -->
<dependency>
@@ -53,12 +53,12 @@ If you're using [Gradle](https://gradle.org/), add this to
your [`build.gradle`]
```groovy
dependencies {
- compile group: 'org.apache.bookkeeper', name: 'bookkeeper-server',
version: '4.16.4'
+ compile group: 'org.apache.bookkeeper', name: 'bookkeeper-server',
version: '4.17.0'
}
// Alternatively:
dependencies {
- compile 'org.apache.bookkeeper:bookkeeper-server:4.16.4'
+ compile 'org.apache.bookkeeper:bookkeeper-server:4.17.0'
}
```
diff --git a/site3/website/versioned_docs/version-4.17.0/overview/overview.md
b/site3/website/versioned_docs/version-4.17.0/overview/overview.md
index c3b1b231b9..2967d72c04 100644
--- a/site3/website/versioned_docs/version-4.17.0/overview/overview.md
+++ b/site3/website/versioned_docs/version-4.17.0/overview/overview.md
@@ -1,6 +1,6 @@
---
id: overview
-title: Apache BookKeeper 4.16.4-SNAPSHOT
+title: Apache BookKeeper 4.17.0
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,7 +21,7 @@ specific language governing permissions and limitations
under the License.
-->
-This documentation is for Apache BookKeeper™ version 4.16.4.
+This documentation is for Apache BookKeeper™ version 4.17.0.
Apache BookKeeper™ is a scalable, fault-tolerant, low-latency storage
service optimized for real-time workloads. It offers durability, replication,
and strong consistency as essentials for building reliable real-time
applications.
@@ -39,7 +39,7 @@
Object/[BLOB](https://en.wikipedia.org/wiki/Binary_large_object) storage | Stori
Learn more about Apache BookKeeper™ and what it can do for your
organization:
-- [Apache BookKeeper 4.16.4 Release Notes](/release-notes#4164)
+- [Apache BookKeeper 4.17.0 Release Notes](/release-notes#4164)
- [Java API docs]({{ site.javadoc_base_url }})
Or start [using](../getting-started/installation) Apache BookKeeper today.
diff --git a/site3/website/versioned_docs/version-4.17.0/reference/config.md
b/site3/website/versioned_docs/version-4.17.0/reference/config.md
index 33cb745ad7..7b53750f38 100644
--- a/site3/website/versioned_docs/version-4.17.0/reference/config.md
+++ b/site3/website/versioned_docs/version-4.17.0/reference/config.md
@@ -280,7 +280,7 @@ The table below lists parameters that you can set to
configure bookies. All conf
| --------- | ----------- | ------- |
| enableStatistics | Whether statistics are enabled for the bookie. | true |
| sanityCheckMetricsEnabled | Flag to enable sanity check metrics in bookie
stats. | false |
-| statsProviderClass | Stats provider class.<br />Options:<br /> - Prometheus
: org.apache.bookkeeper.stats.prometheus.PrometheusMetricsProvider<br /> -
Codahale : org.apache.bookkeeper.stats.codahale.CodahaleMetricsProvider<br
/> - Twitter Finagle :
org.apache.bookkeeper.stats.twitter.finagle.FinagleStatsProvider<br /> -
Twitter Ostrich :
org.apache.bookkeeper.stats.twitter.ostrich.OstrichProvider<br /> - Twitter
Science : org.apache.bookkeeper.stats.twitter.science.TwitterSta [...]
+| statsProviderClass | Stats provider class.<br />Options:<br /> - Prometheus
: org.apache.bookkeeper.stats.prometheus.PrometheusMetricsProvider<br /> -
Codahale : org.apache.bookkeeper.stats.codahale.CodahaleMetricsProvider |
org.apache.bookkeeper.stats.prometheus.PrometheusMetricsProvider |
| limitStatsLogging | option to limit stats logging | true |
@@ -304,23 +304,6 @@ The table below lists parameters that you can set to
configure bookies. All conf
| codahaleStatsSlf4jEndpoint | the slf4j endpoint for reporting stats. see
[slf4j reporter](//metrics.dropwizard.io/3.1.0/manual/core/#slf4j) for more
details. | null |
| codahaleStatsJmxEndpoint | the jmx endpoint for reporting stats. see [jmx
reporter](//metrics.dropwizard.io/3.1.0/manual/core/#jmx) for more details. |
|
-
-## Twitter Ostrich Metrics Provider
-
-| Parameter | Description | Default
-| --------- | ----------- | ------- |
-| statsExport | Flag to control whether to expose ostrich metrics via a http
endpoint configured by `statsHttpPort`. | false |
-| statsHttpPort | The http port of exposing ostrich stats if `statsExport` is
set to true | 9002 |
-
-
-## Twitter Science Metrics Provider
-
-| Parameter | Description | Default
-| --------- | ----------- | ------- |
-| statsExport | Flag to control whether to expose metrics via a http endpoint
configured by `statsHttpPort`. | false |
-| statsHttpPort | The http port of exposing stats if `statsExport` is set to
true | 9002 |
-
-
## AutoRecovery general settings
| Parameter | Description | Default
