Skip to content

Commit

Permalink
Merge pull request #50 from vinooganesh/vinooganesh/update-to-new-web…
Browse files Browse the repository at this point in the history
…site

Update to new website
  • Loading branch information
shangxinli committed Mar 11, 2024
2 parents 032cbf7 + c8ee0d4 commit b3d793b
Show file tree
Hide file tree
Showing 20 changed files with 169 additions and 71 deletions.
22 changes: 21 additions & 1 deletion .asf.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
github:
description: "Apache Parquet"
homepage: https://parquet.apache.org/
labels:
- parquet
- apache
- parquet-site

enabled_merge_buttons:
merge: false
squash: true
rebase: false

features:
wiki: false
issues: true
projects: false
collaborators: # Note: the number of collaborators is limited to 10
- vinooganesh

staging:
profile: ~
whoami: asf-staging

publish:
whoami: asf-site
whoami: asf-site
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

This file was deleted.

1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ To create documentation for a new release of `parquet-mr` create a new <releaseN
# 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`
Expand Down
31 changes: 31 additions & 0 deletions content/en/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
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" 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 %}}


{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/ApacheParquet" %}}
For announcement of latest features etc.
{{% /blocks/feature %}}

{{% /blocks/section %}}
1 change: 1 addition & 0 deletions content/en/docs/Concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ weight: 4
description: >
Glossary of relevant terminology.
---

- *Block (HDFS block)*: This means a block in HDFS and the meaning is
unchanged for describing this file format. The file format is
designed to work well on top of HDFS.
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/File Format/Data Pages/compression.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: "Compression"
linkTitle: "Compression"
weight: 1
---

## Overview

Parquet allows the data block inside dictionary pages and data pages to
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/File Format/Data Pages/encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: "Parquet Modular Encryption"
linkTitle: "Encryption"
weight: 1
---

Parquet files containing sensitive information can be protected by the modular encryption
mechanism that encrypts and authenticates the file data and metadata - while allowing
for a regular Parquet functionality (columnar projection, predicate pushdown, encoding
Expand Down
1 change: 1 addition & 0 deletions content/en/docs/File Format/Types/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ linkTitle: "Types"
weight: 5
---


The types supported by the file format are intended to be as minimal as possible,
with a focus on how the types effect on disk storage. For example, 16-bit ints
are not explicitly supported in the storage format since they are covered by
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/File Format/Types/logicaltypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ of primitive types to a minimum and reuses parquet's efficient encodings. For
example, strings are stored as byte arrays (binary) with a UTF8 annotation.
These annotations define how to further decode and interpret the data.
Annotations are stored as `LogicalType` fields in the file metadata and are
documented in LogicalTypes.md.
documented in LogicalTypes.md.
3 changes: 2 additions & 1 deletion content/en/docs/File Format/configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ weight: 5
---

### Row Group Size

Larger row groups allow for larger column chunks which makes it
possible to do larger sequential IO. Larger groups also require more buffering in
the write path (or a two pass write). We recommend large row groups (512MB - 1GB).
Expand All @@ -18,4 +19,4 @@ Data pages should be considered indivisible so smaller data pages
allow for more fine grained reading (e.g. single row lookup). Larger page sizes
incur less space overhead (less page headers) and potentially less parsing overhead
(processing headers). Note: for sequential scans, it is not expected to read a page
at a time; this is not the IO chunk. We recommend 8KB for page sizes.
at a time; this is not the IO chunk. We recommend 8KB for page sizes.
1 change: 1 addition & 0 deletions content/en/docs/File Format/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ weight: 5
There are three types of metadata: file metadata, column (chunk) metadata and page
header metadata. All thrift structures are serialized using the TCompactProtocol.


![File Layout](/images/FileFormat.gif)
5 changes: 5 additions & 0 deletions content/search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Search Results
layout: search

---
5 changes: 5 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module github.com/apache/parquet-site

go 1.12

require github.com/google/docsy v0.9.1 // indirect
4 changes: 4 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
github.com/FortAwesome/Font-Awesome v0.0.0-20240108205627-a1232e345536/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
github.com/google/docsy v0.9.1 h1:+jqges1YCd+yHeuZ1BUvD8V8mEGVtPxULg5j/vaJ984=
github.com/google/docsy v0.9.1/go.mod h1:saOqKEUOn07Bc0orM/JdIF3VkOanHta9LU5Y53bwN2U=
github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
27 changes: 18 additions & 9 deletions config.toml → hugo.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 @@ -44,16 +41,17 @@ quality = 75
anchor = "smart"

# Language configuration

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

[markup]
[markup.goldmark]
Expand Down Expand Up @@ -98,6 +96,7 @@ 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= "production"

# Comment out to disable search.
Expand All @@ -118,7 +117,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 @@ -155,7 +154,7 @@ enable = false
name ="Twitter"
url = "https://twitter.com/ApacheParquet"
icon = "fab fa-twitter"
desc = "Follow us on Twitter to get the latest news"
desc = "Follow us on Twitter to get the latest news!"
[[params.links.user]]
name = "Stack Overflow"
url = "https://stackoverflow.com/questions/tagged/parquet"
Expand All @@ -166,7 +165,7 @@ enable = false
name = "GitHub"
url = "https://github.com/apache/parquet-mr"
icon = "fab fa-github"
desc = "Development takes place here"
desc = "Development takes place here!"
[[params.links.developer]]
name = "Slack"
url = "https://the-asf.slack.com/"
Expand All @@ -182,3 +181,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
15 changes: 6 additions & 9 deletions layouts/404.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
{{ define "main"}}
<main id="main">
<div>
<h1 id="title">Not found</h1>
<p>Oops! This page doesn't exist. Try going back to our <a href="{{ "/" | relURL }}">home page</a>.</p>

</div>
</main>
{{ end }}
{{ define "main" -}}
<div class="td-content">
<h1>Not found</h1>
<p>Oops! This page doesn't exist. Try going back to the <a href="{{ "" | relURL }}">home page</a>.</p>
</div>
{{- end }}
101 changes: 66 additions & 35 deletions layouts/partials/navbar.html
Original file line number Diff line number Diff line change
@@ -1,35 +1,66 @@
{{ $cover := and (.HasShortcode "blocks/cover") (not .Site.Params.ui.navbar_translucent_over_cover_disable) }}
<nav class="js-navbar-scroll navbar navbar-expand navbar-dark {{ if $cover}} td-navbar-cover {{ end }}flex-column flex-md-row td-navbar">
<a class="navbar-brand" href="{{ .Site.Home.RelPermalink }}">
<span class="navbar-logo">{{ if .Site.Params.ui.navbar_logo }}{{ with resources.Get "icons/logo.svg" }}{{ ( . | minify).Content | safeHTML }}{{ end }}{{ end }}</span><span class="font-weight-bold">{{ .Site.Title }}</span>
</a>
<div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
<ul class="navbar-nav mt-2 mt-lg-0">
{{ $p := . }}
{{ range .Site.Menus.main }}
<li class="nav-item mr-4 mb-2 mb-lg-0">
{{ $active := or ($p.IsMenuCurrent "main" .) ($p.HasMenuCurrent "main" .) }}
{{ with .Page }}
{{ $active = or $active ( $.IsDescendant .) }}
{{ end }}
{{ $pre := .Pre }}
{{ $post := .Post }}
{{ $url := urls.Parse .URL }}
{{ $baseurl := urls.Parse $.Site.Params.Baseurl }}
<a class="nav-link{{if $active }} active{{end}}" href="{{ with .Page }}{{ .RelPermalink }}{{ else }}{{ .URL | relLangURL }}{{ end }}" {{ if ne $url.Host $baseurl.Host }}target="_blank" {{ end }}>{{ with .Pre}}{{ $pre }}{{ end }}<span{{if $active }} class="active"{{end}}>{{ .Name }}</span>{{ with .Post}}{{ $post }}{{ end }}</a>
</li>
{{ end }}
{{ if .Site.Params.versions }}
<li class="nav-item dropdown mr-4 d-none d-lg-block">
{{ partial "navbar-version-selector.html" . }}
</li>
{{ end }}
{{ if (gt (len .Site.Home.Translations) 0) }}
<li class="nav-item dropdown mr-4 d-none d-lg-block">
{{ partial "navbar-lang-selector.html" . }}
</li>
{{ end }}
</ul>
</div>
<div id="search_box" class="navbar-nav d-none d-lg-block">{{ partial "search-input.html" . }}</div>
</nav>
{{ $cover := and
(.HasShortcode "blocks/cover")
(not .Site.Params.ui.navbar_translucent_over_cover_disable)
-}}
{{ $baseURL := urls.Parse $.Site.Params.Baseurl -}}

<nav class="td-navbar navbar-dark js-navbar-scroll
{{- if $cover }} td-navbar-cover {{- end }}">
<div class="container-fluid flex-column flex-md-row">
<a class="navbar-brand" href="{{ .Site.Home.RelPermalink }}">
{{- /**/ -}}
<span class="navbar-brand__logo navbar-logo">
{{- if ne .Site.Params.ui.navbar_logo false -}}
{{ with resources.Get "icons/logo.svg" -}}
{{ ( . | minify).Content | safeHTML -}}
{{ end -}}
{{ end -}}
</span>
{{- /**/ -}}
<span class="navbar-brand__name">
{{- .Site.Title -}}
</span>
{{- /**/ -}}
</a>
<div class="td-navbar-nav-scroll ms-md-auto" id="main_navbar">
<ul class="navbar-nav">
{{ $p := . -}}
{{ range .Site.Menus.main -}}
<li class="nav-item">
{{ $active := or ($p.IsMenuCurrent "main" .) ($p.HasMenuCurrent "main" .) -}}
{{ $href := "" -}}
{{ with .Page -}}
{{ $active = or $active ( $.IsDescendant .) -}}
{{ $href = .RelPermalink -}}
{{ else -}}
{{ $href = .URL | relLangURL -}}
{{ end -}}
{{ $isExternal := ne $baseURL.Host (urls.Parse .URL).Host -}}
<a {{/**/ -}}
class="nav-link {{- if $active }} active {{- end }}" {{/**/ -}}
href="{{ $href }}"
{{- if $isExternal }} target="_blank" rel="noopener" {{- end -}}
>
{{- .Pre -}}
<span>{{ .Name }}</span>
{{- .Post -}}
</a>
</li>
{{ end -}}
{{ if .Site.Params.versions -}}
<li class="nav-item dropdown d-none d-lg-block">
{{ partial "navbar-version-selector.html" . -}}
</li>
{{ end -}}
{{ if (gt (len .Site.Home.Translations) 0) -}}
<li class="nav-item dropdown d-none d-lg-block">
{{ partial "navbar-lang-selector.html" . -}}
</li>
{{ end -}}
</ul>
</div>
<div id="search_box" class="d-none d-lg-block">
{{ partial "search-input.html" . }}
</div>
</div>
</nav>
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
},
"homepage": "https://github.com/apache/parquet-site#readme",
"devDependencies": {
"autoprefixer": "^10.4.4",
"postcss": "^8.4.12",
"autoprefixer": "^10.4.18",
"postcss": "^8.4.35",
"postcss-cli": "^9.1.0"
}
}
1 change: 0 additions & 1 deletion themes/docsy
Submodule docsy deleted from 868b75

0 comments on commit b3d793b

Please sign in to comment.