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

Issue 23739 Fixed documentation syntax, using only Asciidoctor, JBake removed #23741

Merged
merged 34 commits into from
Dec 21, 2021

Conversation

dmatej
Copy link
Contributor

@dmatej dmatej commented Dec 11, 2021

After @OndroMih fixed some things in docs build, I noticed that asciidoc prints many warnings, the build is pretty slow and produces broken PDF files. Those PDF files are broken even in the old 5.1 version.

I tried to avoid updating documentation content, but as it affected results, on many places I did some changes. As we need to improve it much faster and do really huge progress asap, I finally resigned and fixed whatever I saw incorrect. So ...

  • JBake produced really ugly obsoleted HTML, while AsciiDoctor now generates really awesome result
  • Updated dependencies
  • Fixed many corrupted lists and tables, blocks with notes/warnings
  • Fixed titles and replaced syntax using =/-/~/^/+ underline by [=]+ prefixes (not sensitive to the length of the underlined text)
  • Java EE 5,6,7,8 were replaced by Jakarta EE 10 (mostly without the number as it mentioned link to Jakarta EE websites)
  • JDK 5,6,7,8 were replaced by JDK 11
  • glassfish3/4/5/6 paths to glassfish7
  • GlassFish Server Open Source Edition, Enterprise, whatever, it has historically so many names - tried to unify it.
  • Using {productName} property where possible

@dmatej dmatej added this to the 7.0.0 milestone Dec 11, 2021
@dmatej dmatej self-assigned this Dec 11, 2021
@dmatej dmatej linked an issue Dec 11, 2021 that may be closed by this pull request
@dmatej dmatej force-pushed the issue-23739-asciidoc-fixes branch 6 times, most recently from 07d1264 to 98c7f64 Compare December 17, 2021 08:54
@dmatej dmatej marked this pull request as ready for review December 20, 2021 13:53
@dmatej dmatej changed the title Issue 23739 Asciidoc Fixes Issue 23739 Fixed documentation syntax, using only Asciidoctor, JBake removed Dec 20, 2021
- deleted several block which are not valid any more
- repklaced 6/8 by 11, however left 6 where it would mean rewriting the chapter
@dmatej dmatej requested a review from OndroMih December 21, 2021 09:23
@arjantijms arjantijms merged commit ab65469 into eclipse-ee4j:master Dec 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix syntax errors in documentation
3 participants