Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Site appears to be building with old UI #104

Open
oddhack opened this issue Jan 17, 2025 · 6 comments
Open

Site appears to be building with old UI #104

oddhack opened this issue Jan 17, 2025 · 6 comments
Assignees

Comments

@oddhack
Copy link
Collaborator

oddhack commented Jan 17, 2025

I just published docs.vulkan.org for the 1.4.305 Vulkan spec update, as built out of CI, and the site UI appears to have reverted to something older - there's no dark mode switch, in particular.

Possibly this has something to do with the recent big PR @gpx1000 made. There is too much going on in there for me to sort out what may have changed, though I did note that you reverted to incorporating antora-ui-khronos as a submodule(*) and perhaps it's not at the right commit pointer. Steve, can you take a look at this?

(*) I don't know how to resolve this ongoing tension over submodules. I actively despise them. They cause multiple problems on a regular basis, for me. Steve seems to have exactly the opposite view. I don't want to get into dueling commits so we need to find some way to sort this out once and for all.

@SaschaWillems
Copy link
Collaborator

Yeah, as you guessed, it seems to be caused by #101. That PR accidentally reverted the antora UI submodule to a very old version. I could quickly fix this if requested.

@oddhack
Copy link
Collaborator Author

oddhack commented Jan 17, 2025

Yeah, as you guessed, it seems to be caused by #101. That PR accidentally reverted the antora UI submodule to a very old version. I could quickly fix this if requested.

That would be great. Thanks.

@SaschaWillems
Copy link
Collaborator

Okay. Will take a look, but things look really really broken. Just updating the submodule is already giving me merge conflicts :(

@SaschaWillems
Copy link
Collaborator

SaschaWillems commented Jan 17, 2025

Here you go: #105

And yeah, submodules can be a mess. I'm not 100% sure if this PR will fix everything, since github's display of submodule updates is totally useless. But locally it looks to be on the latest commit from the Antora UI repo.

@gpx1000
Copy link
Collaborator

gpx1000 commented Jan 17, 2025 via email

@gpx1000
Copy link
Collaborator

gpx1000 commented Jan 17, 2025

Sascha's PR #105 should fix this safely. Also, if we use the CI workflow, and download from the artifacts on github, then you can validate which version has what with the changes in #106 . That includes the UI.

We should create a khronos antora-luner-search in lieu of the one that antoria uses as we've been pointing at my repo to build a faster search for a while; as antora took a year to accept those same changes. Now those changes are old with the newer search. I made quite a few changes there to include:

  • binary search index
  • patricia-trie with lunr search
  • support for phrases and multiple search terms.

It is possible the Antora project might not want all of those changes. However, the UI needs to point at those latest changes and support the right modules to get it all to work.

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

No branches or pull requests

3 participants