cdi icon indicating copy to clipboard operation
cdi copied to clipboard

Live view of documents (javadoc, spec)

Open jeanouii opened this issue 2 years ago • 2 comments

Is it possible to set up something like netlify to have live previews of PRs and current version of the specification? I know everyone can of course checkout the repo and build the documents. I'm also awayre that markdown/asciidoc allows to easily review PRs, but there links involved and it's sometimes hard to know which part we are refering too.

jeanouii avatar Apr 25 '23 11:04 jeanouii

Here is an example of Netlify the way we use it in the specification repository

https://github.com/jakartaee/specifications/pull/537

@ivargrimstad Do you know if we can set that up and what it takes?

jeanouii avatar Apr 25 '23 14:04 jeanouii

Given that the spec is output as only two files (one html and one PDF), it might also be possible to update the existing CI workflow for PRs to upload those files as the output.

It wouldn't be as convenient for the javadoc, that would need to be uploaded in an archive.

Azquelt avatar Apr 25 '23 15:04 Azquelt