Skip to content

Conversation

@IRus
Copy link

@IRus IRus commented Jan 23, 2026

Very ambitious PR:

  1. Migrate from Jekyll to Hugo: faster builds
  2. Create Github Action to automatically deploy changes from master
  3. Move documentation from undertow-docs branches into flat folder structure in this repo, archive undertow-docs and make changes here
  4. Update to latest bootstrap
  5. Update asciidoctor and switch to sh script instead of maven
  6. I will have to preserve permalinks for SEO, now documentation links are different

I guess the whole point was to make site more modern and integrated.

Compare documentation:

https://irus.github.io/undertow-io-site/documentation/2.0.0/introduction/
https://undertow.io/undertow-docs/undertow-docs-2.0.0/index.html

There is a few bugs, and no 2.1.0 docs yet, but it's can be easily updated as any other comments

5k+ files because of javadoc relocation. I'm thinking that instead of storing them in repo, it should be possible to unpack jar from maven central.

I also don't think that this PR is really possible to review. If overall idea is approved, I can provide multiple smaller PRs that would lead to the same outcome

stuartwdouglas and others added 26 commits September 14, 2018 15:39
Change hello world example to use non-deprecated listener class
Fixed typo in security.asciidoc
- Replace Awestruct/Ruby build with Hugo
- Upgrade to Bootstrap 5 from CDN
- Convert HAML templates to Hugo Go templates
- Migrate AsciiDoc content with Hugo front matter
- Add build-docs.sh for building undertow-docs
- Add GitHub Action for CI/CD deployment to gh-pages
- Add Dockerfile for containerized builds

Co-Authored-By: Claude Opus 4.5 <[email protected]>
git-subtree-dir: docs/2.0.0
git-subtree-mainline: 8df9a33
git-subtree-split: 20fe067
git-subtree-dir: docs/1.3.0
git-subtree-mainline: 722f01d
git-subtree-split: 0d99eba
git-subtree-dir: docs/1.4.0
git-subtree-mainline: 232d8b9
git-subtree-split: 17b5ffc
- Add generate-pdfs.sh to create PDFs using asciidoctor-pdf
- Add build.sh for local build/serve using Docker
- Update Dockerfile to include asciidoctor-pdf and PDF generation
- Simplify CI workflow to use Docker for builds
- Add PDF download links to documentation page

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add BASE_URL build argument to Dockerfile
- CI workflow now dynamically constructs correct GitHub Pages URL
- build.sh supports BASE_URL environment variable for local testing

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Absolute paths don't respect Hugo's baseURL setting. Using relative
paths ensures links work correctly on GitHub Pages subpath deployment.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add Hugo content for documentation versions 2.0.0, 1.4.0, 1.3.0
- Add documentation-specific layouts and templates
- Add documentation images
- Remove old static HTML docs and build script

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add visible active state: bold text with red underline
- Use FirstSection.Title for reliable active detection

Co-Authored-By: Claude Opus 4.5 <[email protected]>
The regex now captures everything before /documentation/ so the
baseURL path is not stripped during version switching.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Use .Section for blog and documentation (sections)
- Use .File.ContentBaseName for downloads and get-involved (single pages)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Find "documentation" in path and get the next element as version,
instead of using hardcoded index which fails with baseURL prefix.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
This ensures all generated URLs are relative to the current page,
which works correctly regardless of baseURL path prefix.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Hugo's variable scoping in range loops was causing the version to
always be 2.0.0. Using findRE extracts the version directly from URL.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
relativeURLs caused path doubling issues. Using absURL for navbar
ensures correct absolute URLs regardless of current page depth.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@ropalka
Copy link
Contributor

ropalka commented Jan 28, 2026

@fl4via just FYI

@rhusar
Copy link
Contributor

rhusar commented Jan 29, 2026

@IRus Awesome stuff, I was thinking the same thing that the website really needs some modernization.

I like how the documentation (really, the most important part) looks like, but having a 'single page' has HUGE advantages as you can just quickly do a control+F from a browser and find what you need, rather than trying to find the section and then do a search. So, if we were to split this, we would need a proper search which is little bit problematic to implement on static pages. Thoughts?

You need to do a rebase, because it's not even mergeable at this point (This branch has conflicts that must be resolved) as something screwed the history.

PS: I was going to say that maybe you should have discussed the technology choice with the project leads @ropalka @fl4via (maybe that did happen?) but then I quickly realized no human is ever going to look at the code, only Claude, so it doesn't really matter as long as it works on GitHub :)

@IRus
Copy link
Author

IRus commented Jan 29, 2026

@rhusar Thank you for checking this out!

I like how the documentation (really, the most important part) looks like, but having a 'single page' has HUGE advantages as you can just quickly do a control+F from a browser and find what you need, rather than trying to find the section and then do a search. So, if we were to split this, we would need a proper search which is little bit problematic to implement on static pages. Thoughts?

Agree. One way to solve this can be a single page with anchors, i.e sidebar still the same, but a single page on the right.

You need to do a rebase, because it's not even mergeable at this point (This branch has conflicts that must be resolved) as something screwed the history.

I'm not planning to merge this exact branch, it's too much vibe-coding and changes for me to comfortably merge it. If idea accepted, I would like to provide multiple smaller pin-point PRs.

@rhusar
Copy link
Contributor

rhusar commented Jan 29, 2026

@rhusar Thank you for checking this out!

I like how the documentation (really, the most important part) looks like, but having a 'single page' has HUGE advantages as you can just quickly do a control+F from a browser and find what you need, rather than trying to find the section and then do a search. So, if we were to split this, we would need a proper search which is little bit problematic to implement on static pages. Thoughts?

Agree. One way to solve this can be a single page with anchors, i.e sidebar still the same, but a single page on the right.

That's exactly what I was thinking but did not want to say explicitly to create bias. So +1!

You need to do a rebase, because it's not even mergeable at this point (This branch has conflicts that must be resolved) as something screwed the history.

I'm not planning to merge this exact branch, it's too much vibe-coding and changes for me to comfortably merge it. If idea accepted, I would like to provide multiple smaller pin-point PRs.

Honestly, one branch for me would be fine, but that's just my personal opinion, project leads need to make that call.

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.