Skip to content

chore: Vendor the UI into this repository#873

Open
lfrancke wants to merge 915 commits into
mainfrom
chore/vendor-ui
Open

chore: Vendor the UI into this repository#873
lfrancke wants to merge 915 commits into
mainfrom
chore/vendor-ui

Conversation

@lfrancke

@lfrancke lfrancke commented Jul 10, 2026

Copy link
Copy Markdown
Member

Description

The UI moves from the documentation-ui submodule into ui/ in this repository.
When I started this documentation project I just forked the upstream Antora UI and that followed this model. That also made it easy to sync with upstream.

But it's been super annoying to have to do two commits (one in documentation-ui and one in documentation) for each design change. So I decided to vendor it in. Any UI changes are now just one PR 🥳

  • This PR should preserve the history as we used git subtree add
  • Build extensions moved supplemental-ui/lib/lib/: supplemental-ui is the UI file overlay, so the extensions were being published to the live site (/_/lib/*.js). They aren't anymore.
  • UI lint/bundle CI moves to .github/workflows/ui.yml, path-filtered on ui/** (the workflow inside ui/.github/ could never trigger from a subdirectory).
  • @antora/lunr-extension removed: dead dependency, search is Pagefind.

Verification

  • Byte-identical build gate: site built from main and from this branch, full diff. Only differences: sitemap <lastmod> timestamps, the intentionally updated sentence on the contributor project-overview page, and the extensions no longer appearing in the published output.
  • netlify-fetch tested against a genuine blobless clone (--filter=blob:none, like Netlify's): local release branches created, all release tip trees fully materialized (verified with a non-lazy-fetching check), working tree clean and HEAD untouched afterwards.
  • npm run bundle --workspace ui works from the repo root (used by the new CI workflow).

Follow-up after merge

Archive the documentation-ui repository with a README pointer

Reviewer's guide

This PR looks huge, but it's not!

  • You can ignore the entire ui subdirectory. It's just copied in
  • You can ignore lib as that is also just a moving around thing
  • You can ignore the github workflow -> also copied

Basically you can look at the playbooks, makefile, README, ...and that's it

graphitefriction and others added 30 commits April 8, 2021 22:55
minor cleanup and edits
resolves #177 add spacing between paragraphs in default table cell
- indent content of details element
- fix top margin of content
- use custom marker to get consistent appearance and behavior
- fully style details element with result role
- change cursor for summary element to pointer
- prevent WebKit from highlighting text of summary element when activated
resolves #178 adjust styles for details element
resolves #64 add support for frame and grid styles on tables
- apply max-width, height, display, and vertical-align properties to object[type="image/svg+xml"] selector
- apply fallback width to object[type="image/svg+xml"] selector when width is not specified (only works in Chrome)
- ignore nowrap on pre element
Version updates, Github workflow, footer etc.
siegfriedweber and others added 22 commits July 17, 2025 15:04
Co-authored-by: Felix Hennig <felix.hennig@stackable.tech>
Co-authored-by: Lars Francke <git@lars-francke.de>
…-search

Add keyboard navigation to search
fix: separate loading of mermaid scripts
feat: disable cookies and remove consent cookie banner
The UI is vendored into this repository in the following commit.
Imported with 'git subtree add' from
https://github.com/stackabletech/documentation-ui.git (branch
stackable), full history preserved. UI changes are now normal PRs in
this repository and show up in deploy previews without a submodule
bump.

git-subtree-dir: ui
git-subtree-mainline: 080032c
git-subtree-split: ba3a4d5
- ui/UPSTREAM records how to diff against antora-ui-default; the first
  reviewed SHA is established by the upcoming upstream re-sync.
- netlify-fetch no longer switches branches: it creates/updates the
  local release branches and materializes their blobs via pathspec
  checkouts (ui/ excluded - release branches still reference it as a
  submodule and its blobs are not needed).
- The UI lint/bundle CI moves to .github/workflows/ui.yml, filtered on
  ui/** (workflows in ui/.github never triggered from a subdirectory).
- The Antora build extensions move from supplemental-ui/lib/ to lib/:
  supplemental-ui is the UI file overlay and everything in it is
  published to the site, which build extensions should not be.
- @antora/lunr-extension is removed: search is Pagefind, nothing
  references the extension.
@netlify

netlify Bot commented Jul 10, 2026

Copy link
Copy Markdown

Deploy Preview for stackable-docs ready!

Name Link
🔨 Latest commit 7f56aa4
🔍 Latest deploy log https://app.netlify.com/projects/stackable-docs/deploys/6a516cc4e5bac600087eb9f7
😎 Deploy Preview https://deploy-preview-873--stackable-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@stackable-cla

stackable-cla Bot commented Jul 10, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ fhennig
❌ Felix Hennig


Felix Hennig seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

The UI files never went through this repository's pre-commit hooks.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Development: Waiting for Review

Development

Successfully merging this pull request may close these issues.