devonfw / ide

Tool to automate setup and update of development environment (esp. for Java projects).
Apache License 2.0
33 stars 102 forks source link

Documentation entirely broken #1320

Closed hohwille closed 10 months ago

hohwille commented 10 months ago

Expected behavior

As a devonfw-ide user, I want to be able to read the offline documentation from the included PDF so that I can lookup some information without going to the online documentation. Also the online documentation only reflects the latest state and if I do have an older version, the documentation might be incorrect.

Actual behavior

Since many releases the documentation is broken. See e.g. https://repo1.maven.org/maven2/com/devonfw/tools/ide/devonfw-ide-doc/2023.08.001/devonfw-ide-doc-2023.08.001.pdf Chapter 1.4 is the last one in the index, after that only asciidoc source-code is displayed in the PDF. On 3. Juli 2023 I posted this in our chat but nobody cared:

Any ideas what we have broken in our documentation?

[INFO] Copying 23 resources 
[INFO] asciidoctor: ERROR: ionic.asciidoc: line 20: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: jasypt.asciidoc: line 20: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: java.asciidoc: line 19: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: jenkins.asciidoc: line 18: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: kotlinc.asciidoc: line 15: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: kotlinc-native.asciidoc: line 15: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: tomcat.asciidoc: line 20: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: kubectl.asciidoc: line 28: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: lazydocker.asciidoc: line 25: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: mvn.asciidoc: line 25: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: ng.asciidoc: line 20: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: node.asciidoc: line 21: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: npm.asciidoc: line 24: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: oc.asciidoc: line 24: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: python.asciidoc: line 29: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: pip.asciidoc: line 29: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: quarkus.asciidoc: line 25: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: release.asciidoc: line 28: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: rewrite.asciidoc: line 42: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: sonar.asciidoc: line 18: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: terraform.asciidoc: line 30: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: vscode.asciidoc: line 29: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: yarn.asciidoc: line 24: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: migration-from-devonfw-3.0.0-or-lower.asciidoc: line 77: table missing leading separator; recovering automatically 
[INFO] asciidoctor: WARN: LICENSE.asciidoc: line 77: unterminated table block 
[INFO] asciidoctor: ERROR: LICENSE.asciidoc: line 79: table missing leading separator; recovering automatically 
[INFO] asciidoctor: ERROR: failed to parse formatted text: <a name="license.asciidoc_apache-software-license---version-2.0">

Steps to reproduce (bug) / Use Case of feature request (enhancement)

  1. generate the documentation (mvn install) or just read it from the link I posted above.

Comments/Hints:

Somebody did place some incorrect/unterminated AsciiDoc markup so from that point all further documentation cannot be processes properly.

Affected version: