Skip to content

docs(release): v0.3.0 anchor + refreshed static docs zip#27

Merged
mjohns-databricks merged 2 commits into
mainfrom
release/v0.3.0-docs
May 19, 2026
Merged

docs(release): v0.3.0 anchor + refreshed static docs zip#27
mjohns-databricks merged 2 commits into
mainfrom
release/v0.3.0-docs

Conversation

@mjohns-databricks
Copy link
Copy Markdown
Collaborator

Summary

Preparation step for cutting the v0.3.0 GitHub Release:

  1. docs/docs/beta-release-notes.mdx — adds ## What's new in v0.3.0 per-version anchor section near the top, so the v0.3.0 release page can link to a summary instead of the cumulative migration table root. Sets a follow-on pattern for v0.4.0 etc. Existing per-component tables below are untouched.
  2. resources/static/geobrix-docs-0.3.0.zip — built via gbx:docs:static-build against this branch HEAD, so the zipped site carries the new anchor. Replaces geobrix-docs-0.2.0.zip (the v0.2.0 GitHub Release already carries its own copy of the 0.2.0 zip; keeping the file in git would cause both versions to land in CI's user-artifacts upload).

No code changes. After merge, build main on the merge commit produces a fresh user-artifacts.zip containing only geobrix-docs-0.3.0.zip, ready for attachment to the v0.3.0 release alongside the JAR / wheel / libgdalalljni.so.

Test plan

  • CI passes end-to-end (pip → setup-python → JFrog → maven-pgp-verify → build → tests).
  • Post-merge `build main` `user-artifacts` artifact contains exactly `geobrix-docs-0.3.0.zip` (no 0.2.0 zip).
  • Confirm rendered docs page on `databrickslabs.github.io/geobrix` shows the new anchor after deploy-docs workflow runs.

This pull request and its description were written by Isaac.

Two preparation steps for cutting the v0.3.0 release:

1. **`docs/docs/beta-release-notes.mdx`** — add a `## What's new in
   v0.3.0` section at the top of the page so the v0.3.0 GitHub Release
   notes can link to a per-version summary anchor (and so v0.4.0 has
   an obvious slot to follow). Existing per-component migration tables
   below the anchor are unchanged.

2. **`resources/static/geobrix-docs-0.3.0.zip`** — built via
   `gbx:docs:static-build`, which packages the rendered Docusaurus
   site with the new v0.3.0 section. Replaces the stale
   `geobrix-docs-0.2.0.zip` so scala_build's
   `cp resources/static/geobrix-docs-*.zip staging/user-artifacts`
   picks up the 0.3.0 zip on the next CI run.

The 0.2.0 zip is removed (not preserved) because the v0.2.0 GitHub
Release already carries its own copy and the file in git was only
used to feed CI's `user-artifacts` upload — keeping it would cause
both zips to be uploaded under the same artifact name on every build.

No code changes. After merge, build_main on main HEAD will produce a
`user-artifacts.zip` containing only `geobrix-docs-0.3.0.zip`, ready
for attachment to the v0.3.0 GitHub Release.

Co-authored-by: Isaac
The "RasterX — " prefix is redundant on bullets that already start with
`rst_…` (or describe rst_*/RasterX context inline). Drop it from the
v0.3.0 highlights so each bullet leads with the specific function or
behavior. Also rewords the example-notebooks bullet — "EO Series +
xView + RasterX enablement diagrams" becomes "EO Series, xView, and
enablement diagrams" (RasterX is implied by the diagrams' subject).

Rebuilt `resources/static/geobrix-docs-0.3.0.zip` so the bundled static
site carries the updated bullets.

Co-authored-by: Isaac
@mjohns-databricks mjohns-databricks merged commit d388976 into main May 19, 2026
5 checks passed
@mjohns-databricks mjohns-databricks deleted the release/v0.3.0-docs branch May 19, 2026 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant