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

Incorporate Jetty 9 #52

Open
joakime opened this issue Jun 20, 2024 · 5 comments
Open

Incorporate Jetty 9 #52

joakime opened this issue Jun 20, 2024 · 5 comments
Assignees

Comments

@joakime
Copy link
Contributor

joakime commented Jun 20, 2024

As I'm actively updating the various URL references to use https://jetty.org/ in the branches, I was wondering if we can also add Jetty 9 docs and javadoc to the jetty.org website.

@jmcc0nn3ll
Copy link
Contributor

@olamy can you dump the jetty 9 javadoc in place with the others? assign to me when your done

@joakime I'll have to mull over the right way to put the jetty 9 docs into place.

@olamy
Copy link
Member

olamy commented Jun 21, 2024

It's already there ;) https://javadoc.jetty.org/jetty-9/

@jmcc0nn3ll jmcc0nn3ll assigned jmcc0nn3ll and unassigned olamy Jul 10, 2024
@jmcc0nn3ll
Copy link
Contributor

jmcc0nn3ll commented Jul 10, 2024

Couple of different ways this could go. We could write a small extension that grabs the HTML artifact and drops it into place to be served under /docs. We could check in the HTML content as a static resource and have it copied into the root of the docs directory. I suspect the first is the more correct way and the second is the ugly, dirtier way.

I'll see about doing it the first way.

@jmcc0nn3ll
Copy link
Contributor

@mojavelinux I am looking at this again, what would you recommend if we want to download a zip file and unpack it to something like jetty.org/docs/jetty-9. Basically just static files.

@mojavelinux
Copy link
Contributor

There are two options.

One approach is to use a script that runs after Antora runs to add files to the files to be published to the web server. That's probably the simplest approach.

Another approach would be to use an Antora extension that essentially does the same thing. An Antora extension can add "site files" (files added to the site catalog), which are files that start from the site root (so they can be anywhere). The extension would download the zip file, open it for reading, and convert each file to a site file. The UI loader in Antora essentially does this, only it's reading a UI bundle and adding the files to the UI catalog.

I don't really see much of a justification for using an Antora extension in this case other than it is purely self-contained. If all you are doing is adding some files to be published alongside the files Antora is publishing, using a post-Antora script is just way simpler and easier to maintain in the long run (likely).

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

4 participants