Skip to content

Update README with details on Docsy and how to make changes to the website #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alamb wants to merge 3 commits into
base: production
Choose a base branch
from
Open

Update README with details on Docsy and how to make changes to the website #166

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27d037e
Minor: Document how docsy templates work
alamb Feb 13, 2026
643bba5
cleanups
alamb Feb 13, 2026
1c98929
whitespace
alamb Feb 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Copy Markdown
Collaborator Author

@alamb alamb Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

drive by cleanup: random stray backtick


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.
Expand Down Expand Up @@ -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:
Expand All @@ -96,7 +96,27 @@ 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. 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
```

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 <releaseNumber>.md file under `content/en/blog/parquet-format`. Please see existing files in that directory as an example.

Expand Down