Skip to content

[preview only] Vendored UI + Vite toolchain combined#875

Draft
lfrancke wants to merge 921 commits into
mainfrom
chore/ui-toolchain
Draft

[preview only] Vendored UI + Vite toolchain combined#875
lfrancke wants to merge 921 commits into
mainfrom
chore/ui-toolchain

Conversation

@lfrancke

Copy link
Copy Markdown
Member

Draft PR whose only purpose is to trigger a Netlify deploy preview of the combined #873 + #874 stack (Netlify does not build previews for PRs based on non-production branches). Do not review or merge - review happens in #873 and #874. This gets closed once those merge.

mojavelinux and others added 30 commits August 4, 2021 02:50
- 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.
- Antora 3 (Rebase with latest upstream changes)
- UI changes for Stackable
- Search integration

Co-authored-by: Dan Allen <dan@opendevise.com>
Co-authored-by: Sven Petersen <s.petersen@webever.de>
Co-authored-by: Guillaume Grossetie <ggrossetie@gmail.com>
Co-authored-by: Edward <edward@encoord.com>
fhennig and others added 27 commits July 17, 2025 15:28
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.
The UI files never went through this repository's pre-commit hooks.
gulp-imagemin minified these on every build; the minified versions are
committed so the build does not need an image pipeline.
The .gitlab-ci.yml and the docs/ component are inherited from
antora-ui-default and were never used here.
Minification strips embedded license header comments from the built
css/js, so the attributions (Font Awesome, highlight.js, Asciidoctor
Tabs, Octicons, the OFL fonts, and the MPL-2.0 upstream fork) live in
a NOTICE file. The build ships it in the UI bundle, which publishes it
on the site.
Vite is what stackable-apps and stackable-cockpit build with, and the
gulp pipeline was frozen: gulp-eslint/gulp-stylelint are unmaintained
and pinned eslint 6 / stylelint 13. Upstream antora-ui-default still
ships the same frozen toolchain, so there is no upstream modernisation
to converge with. Everything starts on the current majors: vite 8,
eslint 10, stylelint 17, archiver 8, Node 24.

- build.mjs produces the identical bundle layout: js entries are built
  as self-contained classic scripts (one vite pass each), the css in a
  separate pass, static directories are copied, NOTICE and LICENSE are
  included, everything is zipped to build/ui-bundle.zip. Verified by
  building the full site with both toolchains: every page is
  byte-identical.
- The vendor bundle sources become ESM and reference the browser build
  of @asciidoctor/tabs explicitly (vite does not honor the style and
  browser package fields the way browserify/postcss-import did).
- CSS custom properties are no longer inlined at build time; every
  supported browser handles var(), and the upcoming design-token work
  needs them preserved.
- The standalone gulp preview is gone; render UI changes with real
  content via 'make build-truly-local' or the deploy preview.
- The stylelint config accepts the inherited upstream css conventions
  instead of reformatting everything right before the planned upstream
  re-sync.
- package-lock.json is regenerated; @antora/* and pagefind are pinned
  to their previously locked versions so the rendered site and search
  assets stay identical (bumping those is Renovate's job).
- Node 24 in .nvmrc/engines/CI, matching stackable-apps. The root
  .nvmrc also raises the Netlify build to Node 24.
background-color/min-width do not accept 'none'; browsers ignored the
declarations, so removing them does not change rendering. Also an
unused event parameter and a stale eslint-disable directive.
@netlify

netlify Bot commented Jul 10, 2026

Copy link
Copy Markdown

Deploy Preview for stackable-docs ready!

Name Link
🔨 Latest commit 68117e6
🔍 Latest deploy log https://app.netlify.com/projects/stackable-docs/deploys/6a524c600f69ad00082e761a
😎 Deploy Preview https://deploy-preview-875--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.

Scoped away from the inherited upstream src/ files until the planned
upstream re-sync, so the diff against antora-ui-default stays readable.
prettier --check runs as part of npm run lint (and therefore in CI).

knip is deliberately not added: handlebars templates and classic
browser scripts have no import graph, and most dependencies are
referenced from playbook YAML or css, so it would need to ignore
nearly everything to stay quiet.
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.