This is an automated email from the ASF dual-hosted git repository.
snazy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new 579a92589 docs(tools): Create the Tools Section in the Docs (#3189)
579a92589 is described below
commit 579a92589a8ad9956a78004fb26c0a5d57afc5ae
Author: Adam Christian
<[email protected]>
AuthorDate: Tue Dec 16 11:30:28 2025 -0500
docs(tools): Create the Tools Section in the Docs (#3189)
---
.../creating-a-catalog/catalog-migration.md | 8 ++---
site/content/tools/_index.md | 35 ++++++++++++++++++++++
site/content/tools/iceberg-catalog-migrator.md | 27 +++++++++++++++++
site/content/tools/polaris-benchmarks.md | 28 +++++++++++++++++
site/content/tools/polaris-synchronizer.md | 27 +++++++++++++++++
site/hugo.yaml | 5 ++++
6 files changed, 126 insertions(+), 4 deletions(-)
diff --git
a/site/content/in-dev/unreleased/getting-started/creating-a-catalog/catalog-migration.md
b/site/content/in-dev/unreleased/getting-started/creating-a-catalog/catalog-migration.md
index e423a3451..3b25ceeb0 100644
---
a/site/content/in-dev/unreleased/getting-started/creating-a-catalog/catalog-migration.md
+++
b/site/content/in-dev/unreleased/getting-started/creating-a-catalog/catalog-migration.md
@@ -24,7 +24,7 @@ weight: 300
---
There are two ways to migrate an existing Iceberg catalog to Polaris:
-1. Using the [Iceberg Catalog Migrator
tool](https://github.com/apache/polaris-tools/blob/main/iceberg-catalog-migrator/README.md):
A command-line tool to migrate Iceberg tables from one Iceberg catalog to
another. This tool works with any existing Iceberg catalog including Polaris.
-2. Using the [Polaris Synchronizer
tool](https://github.com/apache/polaris-tools/blob/main/polaris-synchronizer/README.md):
A tool to migrate entities from one Polaris instance to another. This tool is
specific to Polaris.
-
-Both of these tools are available in the [Polaris-Tools
repository](https://github.com/apache/polaris-tools). Please refer to the
relevant README.md documentation for more information.
+1. Using the [Iceberg Catalog Migrator
tool](../../../../../tools/iceberg-catalog-migrator/): A command-line tool to
migrate Iceberg tables from one Iceberg catalog to another.
+ This tool works with any existing Iceberg catalog including Polaris.
+2. Using the [Polaris Synchronizer
tool](../../../../../tools/polaris-synchronizer/): A tool to migrate entities
from one Polaris instance to another.
+ This tool is specific to Polaris.
diff --git a/site/content/tools/_index.md b/site/content/tools/_index.md
new file mode 100644
index 000000000..3cd0432bc
--- /dev/null
+++ b/site/content/tools/_index.md
@@ -0,0 +1,35 @@
+---
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+linkTitle: 'Tools'
+title: 'Polaris Tools'
+weight: 150
+cascade:
+ type: docs
+---
+
+Polaris has a set of tools to bolster the Polaris ecosystem and provide
additional functionality to work with Polaris and data lakehouses.
+These include:
+
+| Tool | Description
|
+|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Iceberg Catalog Migrator](./iceberg-catalog-migrator/) | Performance
benchmarks for Polaris.
|
+| [Polaris Benchmarks](./polaris-benchmarks/) | A command-line
tool to migrate Iceberg tables from one Iceberg catalog to another.
|
+| [Polaris Synchronizer](./polaris-synchronizer/) | A tool to migrate
entities from one Polaris instance to another. |
+
diff --git a/site/content/tools/iceberg-catalog-migrator.md
b/site/content/tools/iceberg-catalog-migrator.md
new file mode 100644
index 000000000..c52905807
--- /dev/null
+++ b/site/content/tools/iceberg-catalog-migrator.md
@@ -0,0 +1,27 @@
+---
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+title: Iceberg Catalog Migrator
+type: docs
+weight: 100
+---
+
+Iceberg Catalog Migrator is a command-line tool to migrate Iceberg tables from
one Iceberg catalog to another.
+
+To use this tool, please see this
[guide](https://github.com/apache/polaris-tools/blob/main/iceberg-catalog-migrator/README.md).
\ No newline at end of file
diff --git a/site/content/tools/polaris-benchmarks.md
b/site/content/tools/polaris-benchmarks.md
new file mode 100644
index 000000000..1f1b5d015
--- /dev/null
+++ b/site/content/tools/polaris-benchmarks.md
@@ -0,0 +1,28 @@
+---
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+title: Polaris Benchmarks
+type: docs
+weight: 500
+---
+
+Polaris Benchmarks is a tool to measure the performance of Polaris.
+It can be used for comparing the performance of different Polaris instances or
for monitoring the performance of a Polaris instance over time.
+
+To use this tool, please see this
[guide](https://github.com/apache/polaris-tools/blob/main/benchmarks/README.md).
\ No newline at end of file
diff --git a/site/content/tools/polaris-synchronizer.md
b/site/content/tools/polaris-synchronizer.md
new file mode 100644
index 000000000..e01b04df1
--- /dev/null
+++ b/site/content/tools/polaris-synchronizer.md
@@ -0,0 +1,27 @@
+---
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+title: Polaris Synchronizer
+type: docs
+weight: 999
+---
+
+The Polaris Synchronizer is a tool to migrate entities from one Polaris
instance to another.
+
+To use this tool, please see this
[guide](https://github.com/apache/polaris-tools/blob/main/polaris-synchronizer/README.md).
\ No newline at end of file
diff --git a/site/hugo.yaml b/site/hugo.yaml
index bc12c385f..3390f755a 100644
--- a/site/hugo.yaml
+++ b/site/hugo.yaml
@@ -126,6 +126,11 @@ menu:
parent: "doc"
weight: 1000
+ - name: "Tools"
+ identifier: "tools"
+ url: "/tools"
+ weight: 150
+
- name: "Releases"
identifier: "releases"
url: "/downloads"
