Skip to content

Conversation

@oddhack
Copy link
Collaborator

@oddhack oddhack commented Dec 15, 2025

Please ignore the Khronos CLA request if github automatically tagged you as a contributor to the upstream Antora Default UI repository. We will sort this out shortly.

WIP, see dbf080e for TBDs. Have verified that this was done in a way which allows simply merging other Antora Default UI or antora-ui-khronos repo branches, by merging the complete antora-ui-khronos main branch history into Vulkan-Site with --allow-unrelated-histories. 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.

mojavelinux and others added 30 commits January 14, 2022 00:51
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
gpx1000 and others added 19 commits August 6, 2025 09:29
Synchronize with upstream at commit 7823113
* Add new refpages module to navbar

* npm update
Updated the @antora/lunr-extension dependency to use the Khronos Group repository reference. Also corrected the path for the web manifest link in the head-meta template to ensure proper loading.
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
@CLAassistant
Copy link

CLAassistant commented Dec 15, 2025

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 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 Dec 15, 2025

We will have to resolve (combine) the licenses for the combined repos before this can progress. If you got tagged by github as a contributor to the Antora Default UI, please ignore the CLA request. We'll sort it out shortly.

@oddhack
Copy link
Collaborator Author

oddhack commented Dec 17, 2025

@marty-johnson59 @gpx1000 @SaschaWillems I am thinking about asking James to turn off the CLA bot on this repo. We haven't had any actual contributors other than Khronos members AFAICT, and it is going to create a persistent aggravation when merging from the upstream default UI repo (antora-ui-khronos does not have the CLA bot enabled, or we would already have run into this). None of the upstream contributors deserve to get spammed by the bot deciding they need to sign it, which they do not.

I don't see any real downside until such time as someone outside Khronos wanted to contribute to the overall docs site, and probably not even then given nothing in this repo has any Khronos IP considerations. But let me know if you object to turning it off.

@SaschaWillems
Copy link
Collaborator

I'm fine with turning cla off. As you said, chances someone outside Khronos does contribute are low and nothing in here touches Khronos IP.

@gpx1000
Copy link
Collaborator

gpx1000 commented Dec 17, 2025

I completely agree. The only real point there could be headaches involve us contributing back to the antora project itself. However, we could potentially get around that by keeping contributions specific rather than take the full changes we have which wouldn't be desirable by them anyway.

@marty-johnson59
Copy link
Contributor

Works for me..

@oddhack
Copy link
Collaborator Author

oddhack commented Dec 17, 2025

Thanks. I've asked James to turn off CLA on this repo.

@oddhack
Copy link
Collaborator Author

oddhack commented Jan 12, 2026

Apparently despite CLA being turned off, this PR remains blocked on signatures from upstream contributors who should not have been tagged to begin with. Closing this and opening a new PR which, I hope, will not annoy upstream people.

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.

Merge antora-ui-khronos repo into Vulkan-Site