This is an automated email from the ASF dual-hosted git repository.
yuxia pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fluss-rust.git
The following commit(s) were added to refs/heads/main by this push:
new c325929 doc: Add missed API documentation update (#337)
c325929 is described below
commit c32592904303539362af7017587cc76e470d21b7
Author: Keith Lee <[email protected]>
AuthorDate: Tue Feb 17 08:04:51 2026 +0000
doc: Add missed API documentation update (#337)
---
docs/rust-client.md | 0
.../docs/release/create-release.md | 10 +++++++---
{docs => website/docs/release}/generate-release-note.md | 0
.../docs/release}/verifying-a-release-candidate.md | 0
website/docs/user-guide/cpp/api-reference.md | 3 ++-
website/docs/user-guide/rust/api-reference.md | 11 ++++++-----
website/sidebars.ts | 8 +++++++-
{docs/assets => website/static/img}/release-guide.png | Bin
8 files changed, 22 insertions(+), 10 deletions(-)
diff --git a/docs/rust-client.md b/docs/rust-client.md
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/creating-a-release.md b/website/docs/release/create-release.md
similarity index 97%
rename from docs/creating-a-release.md
rename to website/docs/release/create-release.md
index 8b4c868..fc936f9 100644
--- a/docs/creating-a-release.md
+++ b/website/docs/release/create-release.md
@@ -1,3 +1,7 @@
+---
+sidebar_position: 4
+---
+
# Creating a Fluss Rust Client Release
This document describes in detail how to create a release of the **Fluss
clients** (fluss-rust, fluss-python, fluss-cpp) from the
[fluss-rust](https://github.com/apache/fluss-rust) repository. It is based on
the [Creating a Fluss
Release](https://fluss.apache.org/community/how-to-release/creating-a-fluss-release/)
guide of the Apache Fluss project and the [release guide of Apache
OpenDAL](https://nightlies.apache.org/opendal/opendal-docs-stable/community/release/);
releases are source ar [...]
@@ -6,7 +10,7 @@ Publishing software has legal consequences. This guide
complements the foundatio
## Overview
-
+
The release process consists of:
@@ -22,7 +26,7 @@ The release process consists of:
Deciding to release and selecting a Release Manager is the first step. This is
a consensus-based decision of the community.
-Anybody can propose a release (e.g. on the dev mailing list), giving a short
rationale and nominating a committer as Release Manager (including themselves).
Any objections should be resolved by consensus before starting.
+Anybody can propose a release (e.g. on the dev [mailing
list](https://fluss.apache.org/community/welcome/)), giving a short rationale
and nominating a committer as Release Manager (including themselves). Any
objections should be resolved by consensus before starting.
**Checklist to proceed**
@@ -360,7 +364,7 @@ svn commit -m "Remove RC after release fluss-rust
${RELEASE_VERSION}"
2. Choose tag `$RELEASE_TAG`.
3. Set the target to the release branch `release-${RELEASE_VERSION}` (i.e.,
the branch/commit used to create `$RELEASE_TAG`).
4. Click **Generate release notes**, then add: notable changes, breaking
changes (if any) from component upgrade docs, **official download link**
(source archive and verification), and install instructions for fluss-rust,
fluss-python, fluss-cpp.
- - **Download link:**
`https://downloads.apache.org/incubator/fluss/fluss-rust-${RELEASE_VERSION}/`
(or the project download page). In the release description, include checksums
and GPG verification steps.
+ - **Download link:**
`https://downloads.apache.org/incubator/fluss/fluss-rust-${RELEASE_VERSION}/`
(or the project download page). In the release description, include checksums
and GPG verification steps.
5. Click **Publish release**.
### 6. Update CHANGELOG.md on main
diff --git a/docs/generate-release-note.md
b/website/docs/release/generate-release-note.md
similarity index 100%
rename from docs/generate-release-note.md
rename to website/docs/release/generate-release-note.md
diff --git a/docs/verifying-a-release-candidate.md
b/website/docs/release/verifying-a-release-candidate.md
similarity index 100%
rename from docs/verifying-a-release-candidate.md
rename to website/docs/release/verifying-a-release-candidate.md
diff --git a/website/docs/user-guide/cpp/api-reference.md
b/website/docs/user-guide/cpp/api-reference.md
index 47c9307..9cba243 100644
--- a/website/docs/user-guide/cpp/api-reference.md
+++ b/website/docs/user-guide/cpp/api-reference.md
@@ -202,8 +202,9 @@ Complete API reference for the Fluss C++ client.
When using `table.NewRow()`, the `Set()` method auto-routes to the correct
type based on the schema:
-| Method | Description
|
+| Method | Description
|
|----------------------------------------------------------|-----------------------------------|
+| `Set(const std::string& name, std::nullptr_t)` | Set field to null
by column name |
| `Set(const std::string& name, bool value)` | Set boolean by
column name |
| `Set(const std::string& name, int32_t value)` | Set integer by
column name |
| `Set(const std::string& name, int64_t value)` | Set big integer
by column name |
diff --git a/website/docs/user-guide/rust/api-reference.md
b/website/docs/user-guide/rust/api-reference.md
index d5d0671..0929ce6 100644
--- a/website/docs/user-guide/rust/api-reference.md
+++ b/website/docs/user-guide/rust/api-reference.md
@@ -50,11 +50,12 @@ Complete API reference for the Fluss Rust client.
### Partition Operations
-| Method
| Description |
-|--------------------------------------------------------------------------------------------------------------------------|---------------------|
-| `async fn list_partition_infos(&self, table_path: &TablePath) ->
Result<Vec<PartitionInfo>>` | List all partitions |
-| `async fn create_partition(&self, table_path: &TablePath, spec:
&PartitionSpec, ignore_if_exists: bool) -> Result<()>` | Create a partition |
-| `async fn drop_partition(&self, table_path: &TablePath, spec:
&PartitionSpec, ignore_if_not_exists: bool) -> Result<()>` | Drop a partition
|
+| Method
| Description
|
+|--------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|
+| `async fn list_partition_infos(&self, table_path: &TablePath) ->
Result<Vec<PartitionInfo>>` | List all
partitions |
+| `async fn list_partition_infos_with_spec(&self, table_path: &TablePath,
spec: Option<&PartitionSpec>) -> Result<Vec<PartitionInfo>>` | List partitions
matching a spec |
+| `async fn create_partition(&self, table_path: &TablePath, spec:
&PartitionSpec, ignore_if_exists: bool) -> Result<()>` | Create a
partition |
+| `async fn drop_partition(&self, table_path: &TablePath, spec:
&PartitionSpec, ignore_if_not_exists: bool) -> Result<()>` | Drop a
partition |
### Offset Operations
diff --git a/website/sidebars.ts b/website/sidebars.ts
index 51bdd5c..f6fbeac 100644
--- a/website/sidebars.ts
+++ b/website/sidebars.ts
@@ -17,7 +17,13 @@ const sidebars: SidebarsConfig = {
'developer-guide/contributing',
],
},
- 'release',
+ {
+ type: 'category',
+ label: 'Release',
+ items: [
+ {type: 'autogenerated', dirName: 'release'},
+ ],
+ },
],
};
diff --git a/docs/assets/release-guide.png
b/website/static/img/release-guide.png
similarity index 100%
rename from docs/assets/release-guide.png
rename to website/static/img/release-guide.png
