chore: Vendor the UI into this repository (#873)

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>
Co-authored-by: Andrew Kenworthy <andrew.kenworthy@stackable.de>
Co-authored-by: Lars Francke <lars.francke@gmail.com>
Co-authored-by: Felix Hennig <felix.hennig@stackable.tech>
Co-authored-by: Lars Francke <git@lars-francke.de>
Co-authored-by: Ray Offiah <ray@radixdlt.com>
Co-authored-by: Teo Klestrup Röijezon <teo@nullable.se>
Co-authored-by: Siegfried Weber <mail@siegfriedweber.net>
Co-authored-by: Sven Petersen <svenpetersen@gmx.net>
Co-authored-by: Felix Hennig <felix.hennig@stackable.de>
Co-authored-by: Felix Hennig <fhennig@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Techassi <sascha.lautenschlaeger@stackable.tech>
Co-authored-by: xeniape <xenia.fischer@stackable.tech>
Co-authored-by: Nick Larsen <nick.larsen@stackable.tech>
Co-authored-by: Nick <10092581+NickLarsenNZ@users.noreply.github.com>
Co-authored-by: Sebastian Bernauer <sebastian.bernauer@stackable.tech>
Co-authored-by: Stacky McStackface <95074132+stackable-bot@users.noreply.github.com>
Co-authored-by: Techassi <git@techassi.dev>
Co-authored-by: dervoeti <lukas.krug@stackable.tech>
Signed-off-by: dependabot[bot] <support@github.com>

Author: 20 people

.github/workflows/ui.yml

@@ -0,0 +1,20 @@
+---
+name: UI lint and bundle
+
+on:
+  pull_request:
+    paths:
+      - 'ui/**'
+      - 'package-lock.json'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        with:
+          node-version: '16'
+          cache: npm
+      - run: npm ci
+      - run: npm run bundle --workspace ui

.gitmodules

@@ -53,23 +53,26 @@ clean:
 	# 'cache' is the configured cache dir in the playbook
 	rm -rf cache
 
-# The netlify repo is checked out without any blobs. This script
-# iterates through the release branches and checks them out one-by-one
-# to fetch all the files.
-# Then we can build directly from here, making it possible to build
-# with antora using the HEAD (enabling branch previews!)
+# The netlify repo is checked out without any blobs. Antora needs local
+# release branches and their blobs in the object database, so this target
+# creates/updates the local branches and materializes their blobs via
+# pathspec checkouts - without ever switching HEAD (enabling branch previews!).
+# ui/ is excluded: release branches still reference it as a submodule and
+# its blobs are not needed (the UI bundle is built from the current checkout).
 netlify-fetch:
-	git submodule update --init --recursive
 	# netlify messes with some files, restore everything to how it was:
-	git reset --hard --recurse-submodule
+	git reset --hard
 	# fetch, because netlify does caching and we want to get the latest commits
 	git fetch --all
-	# checkout all release branches once, so we fetch the files
 	for remote in $(shell git branch -r | grep -E 'release[/-]'); do \
-		git checkout --recurse-submodules "$${remote#origin/}" ; git pull; \
+		branch="$${remote#origin/}"; \
+		git fetch -q origin "+refs/heads/$$branch:refs/heads/$$branch"; \
+		git checkout -q "$$branch" -- ':(exclude)ui' . ; \
 	done
-	# go back to the initial commit to start the build
-	git -c advice.detachedHead=false checkout --recurse-submodules $(CURRENT_COMMIT)
+	# restore the working tree of the current commit and drop files that
+	# only exist on other branches (ignored files like node_modules stay)
+	git reset --hard -q $(CURRENT_COMMIT)
+	git clean -fdq
 
 netlify-build: netlify-fetch build-prod build-search-index
 

Makefile

@@ -18,11 +18,10 @@ Other Stackable repos contain `docs` directories which are pulled in by this rep
 
 **Dependencies**: `make`, `npm`.
 
-To build the site, pull submodules, install dependencies and run `make`:
+To build the site, install dependencies and run `make`:
 
 [source,console]
 ----
-$ git submodule update --init
 $ npm ci
 $ make
 ----
@@ -61,14 +60,11 @@ content:
     branches: HEAD
 ----
 
-NOTE: Antora does not recognize git submodules as git repositories
-
-The design & layout comes from our https://github.com/stackabletech/documentation-ui[UI repository].
+The design & layout lives in the `ui/` directory of this repository.
 
 `LIVERELOAD=true gulp` may be used to recreate the built documentation after each edit.
 
 == More useful links
 
-* The https://github.com/stackabletech/documentation-ui[documentation-ui] repository.
 * The https://hub.stackable.tech/crds[CRD reference] on the Stackable Hub.
 * The Stackable https://docs.stackable.tech/home/stable/contributor/[contributor's guide] containing more info on how to contribute to the documentation.

README.adoc

@@ -30,8 +30,8 @@ antora:
     - require: '@sntke/antora-mermaid-extension'
       mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
       script_stem: mermaid-scripts
-    - ./supplemental-ui/lib/stackable-operator-helpers.js
-    - ./supplemental-ui/lib/llms-txt.js
+    - ./lib/stackable-operator-helpers.js
+    - ./lib/llms-txt.js
 content:
   sources:
     - url: .

antora-playbook.yml

@@ -15,8 +15,8 @@ antora:
     - require: '@sntke/antora-mermaid-extension'
       mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
       script_stem: mermaid-scripts
-    - ./supplemental-ui/lib/stackable-operator-helpers.js
-    - ./supplemental-ui/lib/llms-txt.js
+    - ./lib/stackable-operator-helpers.js
+    - ./lib/llms-txt.js
 content:
   sources:
     - url: ./

supplemental-ui/lib/llms-txt.js lib/llms-txt.jssupplemental-ui/lib/llms-txt.js renamed to lib/llms-txt.js

@@ -52,7 +52,7 @@ The structure of the repository is documented in its README.
 image::project-overview-documentation.drawio.svg[]
 
 The documentation is built with https://antora.org/[Antora{external-link-icon}^] and the playbook file to build it is located in the https://github.com/stackabletech/documentation[documentation{external-link-icon}^] repository, among some common platform documentation.
-The UI for the documentation is found in the https://github.com/stackabletech/documentation-ui[documentation-ui{external-link-icon}^] repository; it is included as a submodule in the documentation repository.
+The UI for the documentation lives in the `ui/` directory of the same repository.
 The documentation pulls in operator documentation files from the operator repositories.
 The documentation is found at https://docs.stackable.tech/[https://docs.stackable.tech/{external-link-icon}^].
 

…tal-ui/lib/stackable-operator-helpers.js lib/stackable-operator-helpers.jssupplemental-ui/lib/stackable-operator-helpers.js renamed to lib/stackable-operator-helpers.js supplemental-ui/lib/stackable-operator-helpers.js renamed to lib/stackable-operator-helpers.js

@@ -15,8 +15,8 @@ antora:
     - require: '@sntke/antora-mermaid-extension'
       mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
       script_stem: mermaid-scripts
-    - ./supplemental-ui/lib/stackable-operator-helpers.js
-    - ./supplemental-ui/lib/llms-txt.js
+    - ./lib/stackable-operator-helpers.js
+    - ./lib/llms-txt.js
 content:
   sources:
     - url: ./