From c756ba3f660f9bd12a708a9d8bad532fc95e25f3 Mon Sep 17 00:00:00 2001 From: Adam Christian Date: Wed, 12 Nov 2025 07:21:09 -0800 Subject: [PATCH 1/5] docs(tools): Create the Tools Section in the Docs --- .../content/in-dev/unreleased/tools/_index.md | 32 +++++++++++++++++++ .../tools/iceberg-catalog-migrator.md | 27 ++++++++++++++++ .../unreleased/tools/polaris-benchmarks.md | 27 ++++++++++++++++ .../unreleased/tools/polaris-synchronizer.md | 27 ++++++++++++++++ 4 files changed, 113 insertions(+) create mode 100644 site/content/in-dev/unreleased/tools/_index.md create mode 100644 site/content/in-dev/unreleased/tools/iceberg-catalog-migrator.md create mode 100644 site/content/in-dev/unreleased/tools/polaris-benchmarks.md create mode 100644 site/content/in-dev/unreleased/tools/polaris-synchronizer.md diff --git a/site/content/in-dev/unreleased/tools/_index.md b/site/content/in-dev/unreleased/tools/_index.md new file mode 100644 index 0000000000..affd6a02ba --- /dev/null +++ b/site/content/in-dev/unreleased/tools/_index.md @@ -0,0 +1,32 @@ +--- +# +# 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: Tools +type: docs +weight: 999 +--- + +Polaris has a set of tools to help 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/in-dev/unreleased/tools/iceberg-catalog-migrator.md b/site/content/in-dev/unreleased/tools/iceberg-catalog-migrator.md new file mode 100644 index 0000000000..26169e766a --- /dev/null +++ b/site/content/in-dev/unreleased/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). diff --git a/site/content/in-dev/unreleased/tools/polaris-benchmarks.md b/site/content/in-dev/unreleased/tools/polaris-benchmarks.md new file mode 100644 index 0000000000..3ed10d2f98 --- /dev/null +++ b/site/content/in-dev/unreleased/tools/polaris-benchmarks.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 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). diff --git a/site/content/in-dev/unreleased/tools/polaris-synchronizer.md b/site/content/in-dev/unreleased/tools/polaris-synchronizer.md new file mode 100644 index 0000000000..02c26f900c --- /dev/null +++ b/site/content/in-dev/unreleased/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). From 44b1de474dfe1b2c3765870372cb8295bdfda40a Mon Sep 17 00:00:00 2001 From: Adam Christian Date: Wed, 12 Nov 2025 07:25:14 -0800 Subject: [PATCH 2/5] Update the Catalog Migration --- .../getting-started/creating-a-catalog/catalog-migration.md | 6 ++---- 1 file changed, 2 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 e423a3451b..bca7d5be38 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,5 @@ 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. From c21aa8b1e1fc001c6625568bdd365d4b38e9ca82 Mon Sep 17 00:00:00 2001 From: Adam Christian Date: Wed, 12 Nov 2025 07:30:09 -0800 Subject: [PATCH 3/5] Small wording update --- site/content/in-dev/unreleased/tools/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/in-dev/unreleased/tools/_index.md b/site/content/in-dev/unreleased/tools/_index.md index affd6a02ba..79e3bd487f 100644 --- a/site/content/in-dev/unreleased/tools/_index.md +++ b/site/content/in-dev/unreleased/tools/_index.md @@ -22,7 +22,7 @@ type: docs weight: 999 --- -Polaris has a set of tools to help bolster the Polaris ecosystem and provide additional functionality to work with Polaris and data lakehouses. These include: +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 | |---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| From 41367aa43f39d2511bcf7d9212bcf298928cee94 Mon Sep 17 00:00:00 2001 From: Adam Christian Date: Thu, 13 Nov 2025 11:17:40 -0800 Subject: [PATCH 4/5] Update Polaris Projects to be top-level --- .../creating-a-catalog/catalog-migration.md | 4 ++-- .../{in-dev/unreleased/tools => projects}/_index.md | 10 ++++++---- .../tools => projects}/iceberg-catalog-migrator.md | 0 .../tools => projects}/polaris-benchmarks.md | 0 .../tools => projects}/polaris-synchronizer.md | 0 site/hugo.yaml | 5 +++++ 6 files changed, 13 insertions(+), 6 deletions(-) rename site/content/{in-dev/unreleased/tools => projects}/_index.md (88%) rename site/content/{in-dev/unreleased/tools => projects}/iceberg-catalog-migrator.md (100%) rename site/content/{in-dev/unreleased/tools => projects}/polaris-benchmarks.md (100%) rename site/content/{in-dev/unreleased/tools => projects}/polaris-synchronizer.md (100%) 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 bca7d5be38..5c1c12f2b9 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,5 +24,5 @@ weight: 300 --- There are two ways to migrate an existing Iceberg catalog to Polaris: -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. +1. Using the [Iceberg Catalog Migrator tool](../../../../../projects/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](../../../../../projects/polaris-synchronizer/): A tool to migrate entities from one Polaris instance to another. This tool is specific to Polaris. diff --git a/site/content/in-dev/unreleased/tools/_index.md b/site/content/projects/_index.md similarity index 88% rename from site/content/in-dev/unreleased/tools/_index.md rename to site/content/projects/_index.md index 79e3bd487f..b5e231fc4e 100644 --- a/site/content/in-dev/unreleased/tools/_index.md +++ b/site/content/projects/_index.md @@ -17,12 +17,14 @@ # specific language governing permissions and limitations # under the License. # -title: Tools -type: docs -weight: 999 +linkTitle: 'Projects' +title: 'Polaris Projects' +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: +Polaris has a set of projects to bolster the Polaris ecosystem and provide additional functionality to work with Polaris and data lakehouses. These include: | Tool | Description | |---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/site/content/in-dev/unreleased/tools/iceberg-catalog-migrator.md b/site/content/projects/iceberg-catalog-migrator.md similarity index 100% rename from site/content/in-dev/unreleased/tools/iceberg-catalog-migrator.md rename to site/content/projects/iceberg-catalog-migrator.md diff --git a/site/content/in-dev/unreleased/tools/polaris-benchmarks.md b/site/content/projects/polaris-benchmarks.md similarity index 100% rename from site/content/in-dev/unreleased/tools/polaris-benchmarks.md rename to site/content/projects/polaris-benchmarks.md diff --git a/site/content/in-dev/unreleased/tools/polaris-synchronizer.md b/site/content/projects/polaris-synchronizer.md similarity index 100% rename from site/content/in-dev/unreleased/tools/polaris-synchronizer.md rename to site/content/projects/polaris-synchronizer.md diff --git a/site/hugo.yaml b/site/hugo.yaml index 0e4ab966a6..fbb40e35de 100644 --- a/site/hugo.yaml +++ b/site/hugo.yaml @@ -126,6 +126,11 @@ menu: parent: "releases" weight: 1000 + - name: "Projects" + identifier: "projects" + url: "/projects" + weight: 150 + - name: "Downloads" identifier: "downloads" url: "/downloads" From d5e3e64e6f6795af977574e253505c1dd358b279 Mon Sep 17 00:00:00 2001 From: Adam Christian Date: Thu, 13 Nov 2025 11:22:25 -0800 Subject: [PATCH 5/5] Update newlines --- .../getting-started/creating-a-catalog/catalog-migration.md | 6 ++++-- site/content/projects/_index.md | 3 ++- site/content/projects/polaris-benchmarks.md | 3 ++- 3 files changed, 8 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 5c1c12f2b9..b282e34ac5 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,5 +24,7 @@ weight: 300 --- There are two ways to migrate an existing Iceberg catalog to Polaris: -1. Using the [Iceberg Catalog Migrator tool](../../../../../projects/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](../../../../../projects/polaris-synchronizer/): A tool to migrate entities from one Polaris instance to another. This tool is specific to Polaris. +1. Using the [Iceberg Catalog Migrator tool](../../../../../projects/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](../../../../../projects/polaris-synchronizer/): A tool to migrate entities from one Polaris instance to another. +This tool is specific to Polaris. diff --git a/site/content/projects/_index.md b/site/content/projects/_index.md index b5e231fc4e..3fc8f3e1e8 100644 --- a/site/content/projects/_index.md +++ b/site/content/projects/_index.md @@ -24,7 +24,8 @@ cascade: type: docs --- -Polaris has a set of projects to bolster the Polaris ecosystem and provide additional functionality to work with Polaris and data lakehouses. These include: +Polaris has a set of projects to bolster the Polaris ecosystem and provide additional functionality to work with Polaris and data lakehouses. +These include: | Tool | Description | |---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/site/content/projects/polaris-benchmarks.md b/site/content/projects/polaris-benchmarks.md index 3ed10d2f98..ac34bb9d79 100644 --- a/site/content/projects/polaris-benchmarks.md +++ b/site/content/projects/polaris-benchmarks.md @@ -22,6 +22,7 @@ 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. +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).