From 27d037efbbd977b96aa4b4a57b9f152a8b41e6ce Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Fri, 13 Feb 2026 08:48:36 -0500 Subject: [PATCH 1/3] Minor: Document how docsy templates work --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ee0fc6be..02d9ded2 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,29 @@ hugo server --bind 0.0.0.0 # run the server You can now preview the site locally on http://localhost:1313/ -# Release Process +# Docsy Templates + +The HTML for this site comes from the Docsy theme templates, located in the +`github.com/google/docsy` module, which is a dependency of this project. +Overrides to the default docsy templates are in the [layouts] directory. For +example, [layouts/partials] contains the partial templates for HTML pages. + +To make a change to the docsy templates, copy the template you want to change +from the docsy module to the `layouts` directory and then make your changes +there. To see the difference between the default docsy navbar and +the one used in this website use a command such as: + +```shell +diff -du ~/go/pkg/mod/github.com/google/docsy\@v0.12.0/layouts/_partials/navbar.html layouts/partials/navbar.html +``` + +This compares the local copy with the Docsy theme template in the local go cache, +in this case `~/go/pkg/mod/github.com/google/docsy\@v0.12.0/` + + + + +# parquet-java Release Announcment Process To create documentation for a new release of `parquet-format` create a new .md file under `content/en/blog/parquet-format`. Please see existing files in that directory as an example. From 643bba52e220c24d5d922e916949168a093ac055 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Fri, 13 Feb 2026 09:05:33 -0500 Subject: [PATCH 2/3] cleanups --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 02d9ded2..283a0ad4 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This website is built / powered by [Hugo](https://gohugo.io/) with the [Docsy Th The following steps assume that you have `hugo` installed and working. You can also use docker, see the [Docker section](#docker) for more information. -## Updating `/docs/file-format` documentation` +## Updating `/docs/file-format` documentation The `/docs/file-format` pages (for example, https://parquet.apache.org/docs/file-format/data-pages/encodings/) are automatically generated from the `parquet-format` repository. @@ -75,7 +75,7 @@ tools: ```shell docker build -t parquet-site . -```` +``` Then run the container mounting the current directory to `/parquet-site` and exposing local port 1313: @@ -100,25 +100,26 @@ You can now preview the site locally on http://localhost:1313/ The HTML for this site comes from the Docsy theme templates, located in the `github.com/google/docsy` module, which is a dependency of this project. -Overrides to the default docsy templates are in the [layouts] directory. For -example, [layouts/partials] contains the partial templates for HTML pages. +Overrides to the default Docsy templates are in the `layouts/` directory. For +example, `layouts/partials/` contains the partial templates for HTML pages. -To make a change to the docsy templates, copy the template you want to change -from the docsy module to the `layouts` directory and then make your changes -there. To see the difference between the default docsy navbar and -the one used in this website use a command such as: +To make a change to the Docsy templates, copy the template you want to change +from the Docsy module to the `layouts/` directory and then make your changes +there. You can compare the contents of `layouts` with the Docsy templates to see +what has been overridden. For example, to see the difference between the default +Docsy navbar , use a command such as: ```shell -diff -du ~/go/pkg/mod/github.com/google/docsy\@v0.12.0/layouts/_partials/navbar.html layouts/partials/navbar.html +diff -du ~/go/pkg/mod/github.com/google/docsy@v0.12.0/layouts/_partials/navbar.html layouts/partials/navbar.html ``` -This compares the local copy with the Docsy theme template in the local go cache, -in this case `~/go/pkg/mod/github.com/google/docsy\@v0.12.0/` +This compares the local copy with the Docsy theme template in the local Go cache, +in this case `~/go/pkg/mod/github.com/google/docsy@v0.12.0/`. -# parquet-java Release Announcment Process +# parquet-java Release Announcement Process To create documentation for a new release of `parquet-format` create a new .md file under `content/en/blog/parquet-format`. Please see existing files in that directory as an example. From 1c989299f21f963e9a47cf35b41ac7a5d964f9f3 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Fri, 13 Feb 2026 09:06:38 -0500 Subject: [PATCH 3/3] whitespace --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 283a0ad4..4d0dcbd5 100644 --- a/README.md +++ b/README.md @@ -116,9 +116,6 @@ diff -du ~/go/pkg/mod/github.com/google/docsy@v0.12.0/layouts/_partials/navbar.h This compares the local copy with the Docsy theme template in the local Go cache, in this case `~/go/pkg/mod/github.com/google/docsy@v0.12.0/`. - - - # parquet-java Release Announcement Process To create documentation for a new release of `parquet-format` create a new .md file under `content/en/blog/parquet-format`. Please see existing files in that directory as an example.