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

Live view of documents (javadoc, spec) #665

Open
jeanouii opened this issue Apr 25, 2023 · 2 comments
Open

Live view of documents (javadoc, spec) #665

jeanouii opened this issue Apr 25, 2023 · 2 comments

Comments

@jeanouii
Copy link

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
Copy link
Author

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

jakartaee/specifications#537

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

@Azquelt
Copy link
Contributor

Azquelt commented Apr 25, 2023

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.

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

2 participants