Skip to content

Comments

Merge antora-ui-khronos into Vulkan-Site#153

Open
oddhack wants to merge 968 commits intomainfrom
122-merge-ui
Open

Merge antora-ui-khronos into Vulkan-Site#153
oddhack wants to merge 968 commits intomainfrom
122-merge-ui

Conversation

@oddhack
Copy link
Collaborator

@oddhack oddhack commented Jan 12, 2026

This was done with --allow-unrelated-histories, which permits simply merging other Antora Default UI or antora-ui-khronos repo branches. This should make migrating outstanding PRs in the UI repo simple, and updating outstanding PRs in Vulkan-Site needs little more than removing the UI submodule configuration from those branches when retargeting the merged branch.

Closes #122.

Replaces #151 because that was still giving CLA problems. This PR should, hopefully, not do that as we have the CLA turned off on the repository. (edit: the CLA was accidentally turned back on, then off again. I believe that will prevent further unsolicited notifications to contributors to the upstream default UI repo, though we'll have to override the block CLA has placed on merging when this is ready to go.)

mojavelinux and others added 30 commits February 17, 2022 09:42
Style the search box when disabled
resolves #184 use same format of "videoblock" as "imageblock"
* customize scrollbars on html element
* align scrollbar track width between Firefox and Webkit-based browsers
* align scrollbar thumb between Firefox and Webkit-based browsers
… packages to retrieve fonts; use more liberal filter
resolves #187 switch from deprecated typeface- packages to fontsource packages to retrieve fonts
* float-group establishes a block formatting context (without affecting margin collapsing)
* float-gap adds side and bottom margin to a floating element
resolves #189 add support for align=left and align=right on block image
- prevents highlight.js from logging a warning about the unknown language "none"
resolves #69 document how to add and promote static files
gpx1000 and others added 11 commits September 9, 2025 15:44
Implemented functionality to parse and display code blocks with multiple language options. Added a language selector UI for switching between languages and updated CSS to manage visibility of multilang code blocks. Includes local storage support for preferred language persistence.

example source code block:
[source,multilang,javascript,ruby]
.Example Code
----
// START javascript
console.log("Hello");
// END javascript

// START ruby
puts 'Hello'
// END ruby
----
Add multilang support for code blocks with language selector
…ollution warnings

Updated the `hasOwnProperty` check to use `Object.prototype.hasOwnProperty.call` for safer property access in the multilang script. Added `eslint-env browser` directive for linter configuration.
Fix `hasOwnProperty` usage in multilang script to prevent prototype p…
…endor file, and improve CSS formatting for code language selector
Refactor multilang script for clarity, suppress `max-len` in SPIR-V v…
…kan-Site

The purpose is to avoid all the annoyances introduced by a dependency
which will always be built with the site build anyway.

In particular, any PR against Vulkan-Site which relies on a UI submodule
update and persists for any length of time will quickly generate
conflicts with every other such PR.

It should still be possible to merge with the upstream
https://gitlab.com/antora/antora-ui-default[Antora Default UI]
repository if and when we want to.

- Resolved README.adoc conflict by moving the site file into README.Khronos.adoc
- Resolve .gitignore content by merging filters for both repos
- Removed antora-ui-khronos submodule, since it's now part of and built from this branch
- Need to update REUSE configuration and LICENSES / CONTRIBUTING / COPYING files
- Need to modify Github Actions CI scripts to build the UI locally
- Can consider repackaging Vulkan-Site into a subdirectory for a cleaner separation

Adds the following files and directories from antora-ui-khronos:

- .editorconfig
- .eslint*
- .gitlab-ci.yml (UI build in upstream gitlab)
- .gulp.json
- .nvmrc
- .stylelintrc
- LICENSE
- docs/*
- gulp.d/*
- index.js
- package-lock.json
- package.json
- preview-src/*
- src/*

Retains the following files and directories from Vulkan-Site:

- .github/* (Site build in github)
- .reuse
- LICENSES
- docs-site
- CODE_OF_CONDUCT.adoc
- CONTRIBUTING.adoc
- COPYING.adoc
- LICENSE.adoc
- Makefile
- README.adoc
upstream licenses in REUSE.toml (which replaces .reuse/dep5) and runing
REUSE in Github Actions CI.
@CLAassistant
Copy link

CLAassistant commented Feb 11, 2026

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.
0 out of 4 committers have signed the CLA.

❌ SaschaWillems
❌ marty-johnson59
❌ mojavelinux
❌ rosieyohannan
You have signed the CLA already but the status is still pending? Let us recheck it.

@oddhack
Copy link
Collaborator Author

oddhack commented Feb 11, 2026

Apologies again to upstream contributors who are getting spammed - please continue to ignore CLAassistant. It was inadvertently turned back on. It has been disabled again with more comments in config files to, hopefully, prevent this from ever happening again.

Not in the (no longer existent) submodule
@oddhack
Copy link
Collaborator Author

oddhack commented Feb 11, 2026

@gpx1000 @SaschaWillems this seems to work now. CI build succeeds and looks functionally identical to a build using the antora-ui submodule. Once this is merged into main branch we can stop using the separate antora-ui-khronos submodule although any open PRs over there will need to be imported here as well. I'd prefer merging this ASAP because this type of PR does not age well as changes are made in the submodule and upstream.

I have a question about the licensing of various icons and images added under src/img (e.g. android-chrome-192x192.png etc., I think added by Steve) and src/js/vendor/split.js, I think added by Sascha. The repository runs REUSE in CI now, which means that every file must have an assigned copyright and license, and these did not nor could I tell where they came from. ATM the images pick up the MPL-2.0 license of the upstream Antora default UI project thanks to wildcards in REUSE.toml, and split.js was assigned the Apache-2.0 license of Khronos code contributions, but it really looks like something picked up from another repository and which we probably should not claim ownership of, unless Sascha wrote it yourself?

@oddhack oddhack added this to the Needs Sign-Off To Merge milestone Feb 11, 2026
@oddhack oddhack added the process meta-issues for builds, external dependencies, etc. label Feb 11, 2026
@gpx1000
Copy link
Collaborator

gpx1000 commented Feb 11, 2026

I assume if I added those images it's only because they were resized by me of images that were already there. I'm fairly certain I didn't import any images from outside resources just as I equally don't think I created any images from scratch. So, that shouldn't be a problem in the images directory as far as licensing is concerned.

I'll try to review this as soon as I get a chance.

@SaschaWillems
Copy link
Collaborator

src/js/vendor/split.js was indeed added by me and is based on a JavaScript library that afair is using MIT. What's the best way to add this? Add a license disclaimer to the header of said file?

@oddhack
Copy link
Collaborator Author

oddhack commented Feb 14, 2026

src/js/vendor/split.js was indeed added by me and is based on a JavaScript library that afair is using MIT. What's the best way to add this? Add a license disclaimer to the header of said file?

If you point me at the upstream I'll take care of it - should the copyright be solely with the upstream, or do you also want to assert copyright? Best to add a header like

// Copyright <years> <original author>
// {possible additional copyright attribution to you}
// SPDX-License-Identifier: MIT

@SaschaWillems
Copy link
Collaborator

Original repo license is at: https://github.com/nathancahill/split?tab=MIT-1-ov-file#readme

Having a header like this:

// Copyright (c) 2020 Nathan Cahill
// Copyright (c) 2025 Sascha Willems
// SPDX-License-Identifier: MIT

Should do it. Feel free to add.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

process meta-issues for builds, external dependencies, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Merge antora-ui-khronos repo into Vulkan-Site