(skywalking-banyandb) 01/01: Add versions document

[wu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wusheng pushed a commit to branch version
in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git

commit 987aa09e9fef4baeb18767e5a31abede322088ab
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Mon Jan 13 16:11:35 2025 +0800

    Add versions document
---
 docs/installation/versions.md | 25 +++++++++++++++++++++++++
 docs/menu.yml                 |  2 ++
 2 files changed, 27 insertions(+)

diff --git a/docs/installation/versions.md b/docs/installation/versions.md
new file mode 100644
index 00000000..96b6e302
--- /dev/null
+++ b/docs/installation/versions.md
@@ -0,0 +1,25 @@
+# Versions
+
+BanyanDB releases have different API versions and Release versions. To keep the compatibility with SkyWalking
+OAP releases, you need to pick the proper API versions.
+
+| API Version | BanyanDB Release Version |
+|-------------|--------------------------|
+| 0.8         | 0.8                      |
+
+SkyWalking OAP release(since 10.2.0) includes `/config/bydb.dependencies.properties` in the binary indicates required
+API version and tested release version.
+
+```yaml
+# BanyanDB version is the version number of BanyanDB Server release.
+# This is the bundled and tested BanyanDB release version
+bydb.version=0.8
+  # BanyanDB API version is the version number of the BanyanDB query APIs
+  # OAP server has bundled implementation of BanyanDB Java client.
+  # Please check BanyanDB documentation for the API version compatibility.
+  # Each `bydb.api.version` could have multiple compatible release version(`bydb.version`).
+bydb.api.version=0.7
+```
+
+You can select the latest release version of the required APIs to ensure maximum performance and access to the latest
+features.
\ No newline at end of file
diff --git a/docs/menu.yml b/docs/menu.yml
index 992edb81..0a51e8b2 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -37,6 +37,8 @@ catalog:
             path: "/concept/data-model"
       - name: "Quick Start Tutorial"
         path: "/guides/quick-start/quick-start"
+      - name: "Versions and Compatibility"
+        path: "/installation/versions"
   - name: "Interacting"
     catalog:
       - name: "CLI"