You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@parquet.apache.org by al...@apache.org on 2025/10/28 10:46:38 UTC
(parquet-site) branch production updated: Improve introduction / overview, add more links to spec and implementation status (#125)
This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch production
in repository https://gitbox.apache.org/repos/asf/parquet-site.git
The following commit(s) were added to refs/heads/production by this push:
new f6f48d4 Improve introduction / overview, add more links to spec and implementation status (#125)
f6f48d4 is described below
commit f6f48d43ec715f3f7db5e96f0b7d61e6eeaa48da
Author: Andrew Lamb <an...@nerdnetworks.org>
AuthorDate: Tue Oct 28 06:46:33 2025 -0400
Improve introduction / overview, add more links to spec and implementation status (#125)
* Improve introduction / overview, add more links to spec and implementation status
* Update content/en/docs/Overview/_index.md
Co-authored-by: Adam Reeve <ad...@gmail.com>
---------
Co-authored-by: Adam Reeve <ad...@gmail.com>
---
content/en/_index.md | 4 ++--
content/en/docs/Overview/_index.md | 31 +++++++++++++++++--------------
content/en/docs/_index.md | 8 +++++++-
3 files changed, 26 insertions(+), 17 deletions(-)
diff --git a/content/en/_index.md b/content/en/_index.md
index 0c12f5d..61e3360 100644
--- a/content/en/_index.md
+++ b/content/en/_index.md
@@ -18,8 +18,8 @@ It provides high performance compression and encoding schemes to handle complex
{{< blocks/section color="white" type="row">}}
-{{% blocks/feature icon="fab fa-jira" title="Parquet Specification" url="https://github.com/apache/parquet-format" %}}
-Browse the Parquet Specification
+{{% blocks/feature icon="fab fa-jira" title="Documentation" url="docs" %}}
+Browse project documentation including the format specification.
{{% /blocks/feature %}}
{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/apache/parquet-java" %}}
diff --git a/content/en/docs/Overview/_index.md b/content/en/docs/Overview/_index.md
index bf1e1b2..9bcf463 100644
--- a/content/en/docs/Overview/_index.md
+++ b/content/en/docs/Overview/_index.md
@@ -9,37 +9,40 @@ description: >
Apache Parquet is an open source, column-oriented data file format designed for efficient data storage and retrieval.
It provides high performance compression and encoding schemes to handle complex data in bulk and is supported in many programming language and analytics tools.
-This documentation contains information about both the [parquet-java](https://github.com/apache/parquet-java) and [parquet-format](https://github.com/apache/parquet-format) repositories.
-### parquet-format
+### parquet-format (Specification)
-The parquet-format repository hosts the official specification of the Apache Parquet file format, defining how data is structured and stored. This specification, along with Thrift metadata definitions and other crucial components, is essential for developers to effectively read and write Parquet files. The parquet-format project specifically contains the format specifications needed to understand and properly utilize Parquet files.
+The [parquet-format] repository hosts the official specification of the Parquet file format, defining how data is structured and stored. This specification, along with the [parquet.thrift] Thrift metadata definitions, is necessary for developing software to effectively read and write Parquet files.
-As a repository focused on specification, the parquet-format repository does not contain source code.
+Note that the parquet-format repository does not contain source code for libraries to read or write Parquet files, but rather the formal definitions and documentation of the file format itself.
+[parquet-format]: https://github.com/apache/parquet-format
+[parquet.thrift]: https://github.com/apache/parquet-format/blob/master/src/main/thrift/parquet.thrift
### parquet-java
-The parquet-java (formerly named 'parquet-mr') repository is part of the Apache Parquet project and specifically focuses on providing Java tools for handling the Parquet file format. Essentially, this repository includes all the necessary Java libraries and modules that allow developers to read and write Apache Parquet files.
+The [parquet-java] (formerly named `parquet-mr`) repository is part of the Apache Parquet project and contains:
+* Java libraries to read and write Parquet files in Java applications.
+* Utilities and APIs for working with Parquet files, including tools for data import/export, schema management, and data conversion.
-The parquet-java repository contains an implementation of the Apache Parquet format. There are a number of other Parquet format implementations, which are listed below.
-
-Included in parquet-java:
-* Java Implementation: It contains the core Java implementation of the Apache Parquet format, making it possible to use Parquet files in Java applications.
-
-* Utilities and APIs: It provides various utilities and APIs for working with Apache Parquet files, including tools for data import/export, schema management, and data conversion.
+Note that there are a number of other implementations of the Parquet format, some of which are listed below.
+[parquet-java]: https://github.com/apache/parquet-java
### Other Clients / Libraries / Tools
The Parquet ecosystem is rich and varied, encompassing a wide array of tools, libraries, and clients, each offering different levels of feature support. It's important to note that not all implementations support the same features of the Parquet format. When integrating multiple Parquet implementations within your workflow, it is crucial to conduct thorough testing to ensure compatibility and performance across different platforms and tools.
-Here is a non-exhaustive list of Parquet implementations:
+You can find more information about the feature support of various Parquet implementations on the [implementation status] page.
+
+[implementation status]: /docs/file-format/implementationstatus
+
+Here is a non-exhaustive list of open source Parquet implementations:
* [Parquet-java](https://github.com/apache/parquet-java)
* [Parquet C++, a subproject of Arrow C++](https://github.com/apache/arrow/tree/main/cpp/src/parquet) ([documentation](https://arrow.apache.org/docs/cpp/parquet.html))
-* [Parquet Go, a subproject for Arrow Go](https://github.com/apache/arrow-go/tree/main/parquet) ([documentation](https://github.com/apache/arrow-go/tree/main/parquet))
-* [Parquet Rust](https://github.com/apache/arrow-rs/blob/main/parquet/README.md)
+* [Parquet Go, a subproject of Arrow Go](https://github.com/apache/arrow-go/tree/main/parquet) ([documentation](https://github.com/apache/arrow-go/tree/main/parquet))
+* [Parquet Rust, a subproject of Arrow Rust](https://github.com/apache/arrow-rs/blob/main/parquet/README.md)
* [cuDF](https://github.com/rapidsai/cudf)
* [Apache Impala](https://github.com/apache/impala)
* [DuckDB](https://github.com/duckdb/duckdb)
diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md
index 9bf79eb..692989c 100755
--- a/content/en/docs/_index.md
+++ b/content/en/docs/_index.md
@@ -8,4 +8,10 @@ menu:
weight: 2
---
-Welcome to the documentation for Apache Parquet. Here, you can find information about the Parquet File Format, including specifications and developer resources.
+Welcome to the documentation for Apache Parquet.
+
+The specification for the Apache Parquet file format is hosted in the [parquet-format] repository.
+The current implementation status of various features can be found in the [implementation status] page.
+
+[parquet-format]: https://github.com/apache/parquet-format
+[implementation status]: /docs/file-format/implementationstatus