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.

Sign up for GitHub

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

Jump to bottom

Documentation has AsciiDoc syntax errors #590

Closed
hohwille opened this issue Sep 5, 2024 · 1 comment · Fixed by #670
Closed

Documentation has AsciiDoc syntax errors #590

hohwille opened this issue Sep 5, 2024 · 1 comment · Fixed by #670
Assignees
@alfeilex
Labels
enhancement New feature or request

Comments

@hohwille
Copy link
Member

hohwille commented Sep 5, 2024

Our build logs are spammed since many month with warnings and especially the entire source code of the LICENSE.adoc that got a syntax error by some PR adding to the documentation.

These are the errors from asciidoctor:

[INFO] asciidoctor: ERROR: projects.adoc: line 51: table missing leading separator; recovering automatically
[INFO] asciidoctor: WARN: LICENSE.adoc: line 84: unterminated table block
[INFO] asciidoctor: ERROR: LICENSE.adoc: line 86: table missing leading separator; recovering automatically
[INFO] asciidoctor: ERROR: failed to parse formatted text: <a name="license.adoc_apache-software-license---version-2.0"></a> == Apache

Initial task of this story is to analyze and fix these errors.

If possible we should configure asciidoctor to fail on errors. Then the PR introducing the error would get a red build and we would not merge it before the error gets fixed.
@hohwille hohwille added the enhancement New feature or request label Sep 5, 2024
@github-project-automation github-project-automation bot moved this to 🆕 New in IDEasy board Sep 5, 2024
@alfeilex alfeilex self-assigned this Oct 1, 2024
@alfeilex alfeilex moved this from 🆕 New to 🏗 In progress in IDEasy board Oct 1, 2024
alfeilex added a commit to alfeilex/IDEasy that referenced this issue Oct 1, 2024
@alfeilex
Merge branch 'devonfw:main' into devonfw#590-asciidoc
9cf2e83
This was referenced Oct 1, 2024
Merged
Closed
@alfeilex
Copy link
Member

alfeilex commented Oct 1, 2024

Derived issue for doc-gen to configure that the build process fails when there are errors in adoc files

alfeilex added a commit to alfeilex/IDEasy that referenced this issue Oct 1, 2024
@alfeilex
Merge branch 'main' into devonfw#590-asciidoc
613908f
alfeilex added a commit to alfeilex/IDEasy that referenced this issue Oct 1, 2024
@alfeilex
Merge branch 'main' into devonfw#590-asciidoc
3ea62ab
This was referenced Oct 1, 2024
Closed
Closed
Closed
alfeilex added a commit to alfeilex/IDEasy that referenced this issue Oct 1, 2024
@alfeilex
Merge branch 'main' into devonfw#590-asciidoc
8e788d7
@alfeilex alfeilex mentioned this issue Oct 1, 2024
Merged
hohwille added a commit to alfeilex/IDEasy that referenced this issue Oct 9, 2024
@hohwille
Merge branch 'main' into devonfw#590-asciidoc
7c46a0e
hohwille pushed a commit that referenced this issue Oct 10, 2024
@alfeilex
#590: Fix Asciidoc files in documentation causing errors (#670)
9afd932
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in IDEasy board Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alfeilex alfeilex

Labels
enhancement New feature or request
Projects
IDEasy board
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

#590: Fix Asciidoc files in documentation causing errors alfeilex/IDEasy
2 participants
@hohwille @alfeilex