-
Task
-
Resolution: Done
-
Critical
-
Che 7.5
-
None
-
devex docs #184 May 13-Jun 2, devex docs #185 Jun 3-Jun 25, devex docs #188 Aug 6-Aug 28, devex docs #189 Aug 28-Sep 18
-
13
-
Documentation (Ref Guide, User Guide, etc.)
Build Eclipse Che documentation with Antora.
Rationale:
- Currently built with Jekyll. Theme and jekyll version are very old and unmaintained. Security alerts on jekyll components https:https://github.com/eclipse/che-docs/pull/904 https://github.com/eclipse/che-docs/pull/896
- Website will be easier to maintain with Antora.
- ffloreth did some preliminary analysis which shows there is not too much work to achieve the goal: https://github.com/themr0c/che-docs/blob/antora/README-antora.adoc
DONE: These requirements are met in https://github.com/themr0c/che-docs/tree/antora
- Usage documentation: README-antora.adoc
- Build script: run_antora.sh
- Playbook definition including attributes: antora-playbook.yml.
- Component definition: antora.yml
- Modules organization: modules/ with symbolik links.
- Handle UI: header and footer (supplemental-ui).
- Handle navigation: modules/<module-name>/nav.adoc.
TODO
- Replace all internal links using link: by proper xref:. -> Need to apply substitutions when we switch publication platform.
- Handle images. (no support for subdirectories). -> Need to move files and apply substitutions when we switch publication platform.
- Handle jekyll headers. (Remove them?). -> Need to apply substitutions when we switch publication platform.
- Handle redirections from older publish URL. -> Need list of URLs to redirect. Then create an .htaccess in supplemental-ui.
- Handle publication of website. -> Modify Jenkins job
- Handle publication of WAR to embed in Che. -> just a copy. The WAR is built by Che. (verify why we have this war option in current build script).