Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-1525

[PUBLISHING] Antora for Eclipse Che?

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Critical Critical
    • Che 7.14
    • Che 7.5
    • Eclipse Che
    • 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:

      DONE: These requirements are met in https://github.com/themr0c/che-docs/tree/antora

      1. Usage documentation: README-antora.adoc
      2. Build script: run_antora.sh
      3. Playbook definition including attributes: antora-playbook.yml.
      4. Component definition: antora.yml
      5. Modules organization: modules/ with symbolik links.
      6. Handle UI: header and footer (supplemental-ui).
      7. Handle navigation: modules/<module-name>/nav.adoc.

      TODO

      1. Replace all internal links using link: by proper xref:. -> Need to apply substitutions when we switch publication platform.
      2. Handle images. (no support for subdirectories). -> Need to move files and apply substitutions when we switch publication platform.
      3. Handle jekyll headers. (Remove them?). -> Need to apply substitutions when we switch publication platform.
      4. Handle redirections from older publish URL. -> Need list of URLs to redirect. Then create an .htaccess in supplemental-ui.
      5. Handle publication of website. -> Modify Jenkins job
      6. 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).

            ffloreth@redhat.com Fabrice Flore-Thébault
            ffloreth@redhat.com Fabrice Flore-Thébault
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: