Skip to content

Commit

Permalink
This PR does a few things:
Browse files Browse the repository at this point in the history
Moves from the docsy git submodule to hugo modules
Pulls in the changes from production to bring staging up to the same point
Updates the github actions versions
Modes from _index.html -> _index.md for the site root
Updates the 404 page
  • Loading branch information
vinooganesh committed Feb 27, 2024
1 parent 3e4d218 commit f728ba1
Show file tree
Hide file tree
Showing 27 changed files with 279 additions and 59 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ on:

jobs:
Build_and_Deploy_Site:
runs-on: ubuntu-20.04
runs-on: ubuntu-22.04
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
with:
submodules: recursive
fetch-depth: 0
Expand All @@ -21,12 +21,12 @@ jobs:
hugo-version: 'latest'
extended: true

- uses: actions/setup-node@v2
- uses: actions/setup-node@v4
with:
node-version: '16'
node-version: '20'

- name: Cache dependencies
uses: actions/cache@v1
uses: actions/cache@v4
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
Expand Down
4 changes: 0 additions & 4 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,4 +0,0 @@

[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/google/docsy
26 changes: 17 additions & 9 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ enableMissingTranslationPlaceholders = true

enableRobotsTXT = true

# Base theme for website
theme = ["docsy"]

# Will give values to .Lastmod etc.
enableGitInfo = true

Expand Down Expand Up @@ -47,9 +44,13 @@ anchor = "smart"

[languages]
[languages.en]
languageName ="English"
# Weight used for sorting.
weight = 1
[languages.en.params]
title = "Apache Parquet"
description = "The Apache Parquet Website"
languageName ="English"

contentDir = "content/en"
# Weight used for sorting.
weight = 1
Expand Down Expand Up @@ -98,14 +99,11 @@ url_latest_version = "https://parquet.apache.org"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/apache/parquet-site"
github_branch= "main"
github_branch= "staging"

# Comment out to disable search.
gcs_engine_id = "7e3f91e3eadecceaa"

# Enable Algolia DocSearch
algolia_docsearch = false

# Enable Lunr.js offline search
offlineSearch = false

Expand All @@ -118,7 +116,7 @@ prism_syntax_highlighting = false
# Set to true to disable breadcrumb navigation.
breadcrumb_disable = false
# Set to true to disable the About link in the site footer
footer_about_disable = false
footer_about_enable = true
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
navbar_logo = true
# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
Expand Down Expand Up @@ -182,3 +180,13 @@ enable = false
url = "https://issues.apache.org/jira/projects/PARQUET/issues"
icon = "fas fa-bug"
desc = "File/Track Open Bugs"

[module]
# Uncomment the next line to build and serve using local docsy clone declared in the named Hugo workspace:
# workspace = "docsy.work"
[module.hugoVersion]
extended = true
min = "0.110.0"
[[module.imports]]
path = "github.com/google/docsy"
disable = false
36 changes: 15 additions & 21 deletions content/en/_index.html → content/en/_index.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,24 @@
+++
title = "Apache Parquet"
linkTitle = "Parquet"

+++

{{< blocks/cover title="Apache Parquet" image_anchor="top" height="full" color="blue" >}}
<div class="mx-auto">
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
Documentation <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="{{< relref "/blog" >}}">
Download <i class="fas fa-download ml-2 "></i>
</a>
<p class="lead mt-5">Apache Parquet is a columnar storage format available to any project in the Hadoop ecosystem, regardless of the choice of data processing framework, data model or programming language.</p>
{{< blocks/link-down color="info" >}}
</div>
---
title: Parquet
---

{{< blocks/cover title="Apache Parquet" image_anchor="top" height="full" >}}
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/">
Documentation <i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
<a class="btn btn-lg btn-secondary me-3 mb-4" href="/blog/">
Download <i class="fab fa-github ms-2 "></i>
</a>
<p class="lead mt-5">Apache Parquet is a columnar storage format available to any project in the Hadoop ecosystem, regardless of the choice of data processing framework, data model or programming language.</p>
{{< blocks/link-down color="info" >}}
{{< /blocks/cover >}}


{{< blocks/section color="white" >}}
{{< blocks/section color="white" type="row">}}
{{% blocks/feature icon="fab fa-jira" title="File an Issue" url="https://issues.apache.org/jira/projects/PARQUET/issues" %}}
Or Search Open Issues
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/apache/parquet-mr" %}}
We do a [Pull Request](https://github.com/apache/parquet-mr/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}
Expand All @@ -33,5 +28,4 @@
For announcement of latest features etc.
{{% /blocks/feature %}}


{{< /blocks/section >}}
{{% /blocks/section %}}
41 changes: 41 additions & 0 deletions content/en/blog/parquet-mr/1.12.3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "1.12.3"
date: 2022-05-26
description: >
---
The [latest version of parquet-mr is 1.12.3](https://www.apache.org/dyn/closer.lua/parquet/apache-parquet-1.12.3/apache-parquet-1.12.3.tar.gz).

To [check the validity](https://www.apache.org/info/verification.html) of this release, use its:

* [Release manager OpenPGP key](https://downloads.apache.org/parquet/KEYS)
* [OpenPGP signature](https://downloads.apache.org/parquet/apache-parquet-1.12.3/apache-parquet-1.12.3.tar.gz.asc)
* [SHA-512](https://downloads.apache.org/parquet/apache-parquet-1.12.3/apache-parquet-1.12.3.tar.gz.sha512)

The [latest version of parquet-mr on the previous minor branch is 1.11.2](https://www.apache.org/dyn/closer.lua/parquet/apache-parquet-1.11.2/apache-parquet-1.11.2.tar.gz).

To [check the validity](https://www.apache.org/info/verification.html) of this release, use its:

* [Release manager OpenPGP key](https://downloads.apache.org/parquet/KEYS)
* [OpenPGP signature](https://downloads.apache.org/parquet/apache-parquet-1.11.2/apache-parquet-1.11.2.tar.gz.asc)
* [SHA-512](https://downloads.apache.org/parquet/apache-parquet-1.11.2/apache-parquet-1.11.2.tar.gz.sha512)

### Downloading from the Maven central repository

The Parquet team publishes its [releases to Maven Central](https://search.maven.org/search?q=g:org.apache.parquet).

Add the following dependency section to your pom.xml:
```
<dependencies>
...
<dependency>
<groupId>org.apache.parquet</groupId>
<artifactId>parquet-avro</artifactId>
<version>1.12.3</version> <!-- or latest version -->
</dependency>
...
</dependencies>
```

### Older Releases

Older releases can be found in the Archives of the Apache Software Foundation: [https://archive.apache.org/dist/parquet/](https://archive.apache.org/dist/parquet/)
41 changes: 41 additions & 0 deletions content/en/blog/parquet-mr/1.13.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "1.13.0"
date: 2023-04-06
description: >
---
The [latest version of parquet-mr is 1.13.0](https://downloads.apache.org/parquet/apache-parquet-1.13.0/apache-parquet-1.13.0.tar.gz).

To [check the validity](https://www.apache.org/info/verification.html) of this release, use its:

* [Release manager OpenPGP key](https://downloads.apache.org/parquet/KEYS)
* [OpenPGP signature](https://downloads.apache.org/parquet/apache-parquet-1.13.0/apache-parquet-1.13.0.tar.gz.asc)
* [SHA-512](https://downloads.apache.org/parquet/apache-parquet-1.13.0/apache-parquet-1.13.0.tar.gz.sha512)

The [latest version of parquet-mr on the previous minor branch is 1.12.3](https://downloads.apache.org/parquet/apache-parquet-1.12.3/apache-parquet-1.12.3.tar.gz).

To [check the validity](https://www.apache.org/info/verification.html) of this release, use its:

* [Release manager OpenPGP key](https://downloads.apache.org/parquet/KEYS)
* [OpenPGP signature](https://downloads.apache.org/parquet/apache-parquet-1.12.3/apache-parquet-1.12.3.tar.gz.asc)
* [SHA-512](https://downloads.apache.org/parquet/apache-parquet-1.12.3/apache-parquet-1.12.3.tar.gz.sha512)

### Downloading from the Maven central repository

The Parquet team publishes its [releases to Maven Central](https://search.maven.org/search?q=g:org.apache.parquet).

Add the following dependency section to your pom.xml:
```
<dependencies>
...
<dependency>
<groupId>org.apache.parquet</groupId>
<artifactId>parquet-avro</artifactId>
<version>1.13.0</version> <!-- or latest version -->
</dependency>
...
</dependencies>
```

### Older Releases

Older releases can be found in the Archives of the Apache Software Foundation: [https://archive.apache.org/dist/parquet/](https://archive.apache.org/dist/parquet/)
41 changes: 41 additions & 0 deletions content/en/blog/parquet-mr/1.13.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "1.13.1"
date: 2023-05-18
description: >
---
The [latest version of parquet-mr is 1.13.1](https://downloads.apache.org/parquet/apache-parquet-1.13.1/apache-parquet-1.13.1.tar.gz).

To [check the validity](https://www.apache.org/info/verification.html) of this release, use its:

* [Release manager OpenPGP key](https://downloads.apache.org/parquet/KEYS)
* [OpenPGP signature](https://downloads.apache.org/parquet/apache-parquet-1.13.1/apache-parquet-1.13.1.tar.gz.asc)
* [SHA-512](https://downloads.apache.org/parquet/apache-parquet-1.13.1/apache-parquet-1.13.1.tar.gz.sha512)

The [latest version of parquet-mr on the previous minor branch is 1.12.3](https://downloads.apache.org/parquet/apache-parquet-1.12.3/apache-parquet-1.12.3.tar.gz).

To [check the validity](https://www.apache.org/info/verification.html) of this release, use its:

* [Release manager OpenPGP key](https://downloads.apache.org/parquet/KEYS)
* [OpenPGP signature](https://downloads.apache.org/parquet/apache-parquet-1.12.3/apache-parquet-1.12.3.tar.gz.asc)
* [SHA-512](https://downloads.apache.org/parquet/apache-parquet-1.12.3/apache-parquet-1.12.3.tar.gz.sha512)

### Downloading from the Maven central repository

The Parquet team publishes its [releases to Maven Central](https://search.maven.org/search?q=g:org.apache.parquet).

Add the following dependency section to your pom.xml:
```
<dependencies>
...
<dependency>
<groupId>org.apache.parquet</groupId>
<artifactId>parquet-avro</artifactId>
<version>1.13.1</version> <!-- or latest version -->
</dependency>
...
</dependencies>
```

### Older Releases

Older releases can be found in the Archives of the Apache Software Foundation: [https://archive.apache.org/dist/parquet/](https://archive.apache.org/dist/parquet/)
7 changes: 7 additions & 0 deletions content/en/docs/ASF/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Apache Software Foundation (ASF)"
linkTitle: "Apache Software Foundation (ASF)"
weight: 25
description: >
Apache Software Foundation
---
7 changes: 7 additions & 0 deletions content/en/docs/ASF/donate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Donate"
linkTitle: "Donate"
weight: 4
---

[Donate](https://www.apache.org/foundation/sponsorship.html)
7 changes: 7 additions & 0 deletions content/en/docs/ASF/events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Events"
linkTitle: "Events"
weight: 5
---

[Events](https://apachecon.com/?ref=parquet.apache.org)
7 changes: 7 additions & 0 deletions content/en/docs/ASF/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "License"
linkTitle: "License"
weight: 1
---

[License](https://www.apache.org/licenses/)
7 changes: 7 additions & 0 deletions content/en/docs/ASF/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Security"
linkTitle: "Security"
weight: 2
---

[Security](https://www.apache.org/security/)
7 changes: 7 additions & 0 deletions content/en/docs/ASF/sponsor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Sponsor"
linkTitle: "Sponsor"
weight: 3
---

[Sponsor](https://www.apache.org/foundation/thanks.html)
27 changes: 25 additions & 2 deletions content/en/docs/Contribution Guidelines/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: >
Pull Requests
-------------

We prefer to receive contributions in the form of GitHub pull requests. Please send pull requests against the [github.com/apache/parquet-mr](https://github.com/apache/parquet-mr) repository. If you’ve previously forked Parquet from its old location, you will need to add a remote or update your origin remote to [https://github.com/apache/incubator-parquet-mr.git](https://github.com/apache/incubator-parquet-mr.git) Here are a few tips to get your contribution in:
We prefer to receive contributions in the form of GitHub pull requests. Please send pull requests against the [github.com/apache/parquet-mr](https://github.com/apache/parquet-mr) repository. If you’ve previously forked Parquet from its old location, you will need to add a remote or update your origin remote to [https://github.com/apache/parquet-mr.git](https://github.com/apache/parquet-mr.git) Here are a few tips to get your contribution in:

1. Break your work into small, single-purpose patches if possible. It’s much harder to merge in a large change with a lot of disjoint features.
2. Create a JIRA for your patch on the [Parquet Project JIRA](https://issues.apache.org/jira/browse/PARQUET).
Expand Down Expand Up @@ -95,5 +95,28 @@ For now just say `n` as we have 1 branch

Website
-------
### Release Documentation

TODO
To create documentation for a new release of `parquet-format` create a new <releaseNumber>.md file under `content/en/blog/parquet-format`. Please see existing files in that directory as an example.

To create documentation for a new release of `parquet-mr` create a new <releaseNumber>.md file under `content/en/blog/parquet-mr`. Please see existing files in that directory as an example.

### Website development and deployment

#### Staging

To make a change to the `staging` version of the website:
1. Make a PR against the `staging` branch in the repository
2. Once the PR is merged, the `Build and Deploy Parquet Site`
job in the [deployment workflow](https://github.com/apache/parquet-site/blob/staging/.github/workflows/deploy.yml) will be run, populating the `asf-staging` branch on this repo with the necessary files.

**Do not directly edit the `asf-staging` branch of this repo**

#### Production

To make a change to the `production` version of the website:
1. Make a PR against the `production` branch in the repository
2. Once the PR is merged, the `Build and Deploy Parquet Site`
job in the [deployment workflow](https://github.com/apache/parquet-site/blob/production/.github/workflows/deploy.yml) will be run, populating the `asf-site` branch on this repo with the necessary files.

**Do not directly edit the `asf-site` branch of this repo**
2 changes: 1 addition & 1 deletion content/en/docs/Contribution Guidelines/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The [parquet-format](https://github.com/apache/parquet-format) project contains

The [parquet-mr](https://github.com/apache/parquet-mr) project contains multiple sub-modules, which implement the core components of reading and writing a nested, column-oriented data stream, map this core onto the parquet format, and provide Hadoop Input/Output Formats, Pig loaders, and other Java-based utilities for interacting with Parquet.

The [parquet-cpp](https://github.com/apache/parquet-cpp) project is a C++ library to read-write Parquet files.
The [parquet-cpp](https://arrow.apache.org/docs/cpp/parquet.html) project is a C++ library to read-write Parquet files. It is part of the [Apache Arrow](https://arrow.apache.org/) C++ implementation, with bindings to Python, R, Ruby and C/GLib.

The [parquet-rs](https://github.com/apache/arrow-rs/tree/master/parquet) project is a Rust library to read-write Parquet files.

Expand Down
Loading

0 comments on commit f728ba1

Please sign in to comment.