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

#590: Fix Asciidoc files in documentation causing errors #670

Merged
merged 9 commits into from
Oct 10, 2024

Conversation

alfeilex
Copy link
Member

@alfeilex alfeilex commented Oct 1, 2024

Fixes: #590

The main error occured by a missing line break of |== in projects.adoc. It looks like it traverse until Licence.adoc.

Further some links were incorrectly set to other files. E.g link:setups.asciidoc instead of link:setups.adoc.

Finally some refactoring suggested by intellij was made, because = <title> main title should be before [toc]. There are some other adoc files that have that, but it is not critical error that is also not recognized by asciidoctor-maven-plugin

Copy link
Contributor

@jan-vcapgemini jan-vcapgemini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I've added a small suggestion.

documentation/LICENSE.adoc Outdated Show resolved Hide resolved
Co-authored-by: jan-vcapgemini <59438728+jan-vcapgemini@users.noreply.github.com>
@alfeilex alfeilex marked this pull request as ready for review October 1, 2024 15:01
@coveralls
Copy link
Collaborator

coveralls commented Oct 1, 2024

Pull Request Test Coverage Report for Build 11259913657

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.02%) to 66.533%

Files with Coverage Reduction New Missed Lines %
com/devonfw/tools/ide/url/model/file/json/ToolDependencies.java 1 76.92%
Totals Coverage Status
Change from base Build 11141097628: 0.02%
Covered Lines: 6127
Relevant Lines: 8868

💛 - Coveralls

documentation/LICENSE.adoc Outdated Show resolved Hide resolved
@hohwille hohwille added this to the release:2024.10.001 milestone Oct 8, 2024
@hohwille hohwille added documentation Improvements or additions to documentation bugfix labels Oct 8, 2024
@hohwille hohwille self-assigned this Oct 8, 2024
@hohwille
Copy link
Member

hohwille commented Oct 8, 2024

[INFO] --- asciidoctor-maven-plugin:1.6.0:process-asciidoc (generate-doc) @ ide-doc ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 19 resources
[INFO] Rendered /home/runner/work/IDEasy/IDEasy/documentation/target/asciidoc/IDEasy.adoc

So nice. Thanks @alfeilex 👍

@hohwille hohwille merged commit 9afd932 into devonfw:main Oct 10, 2024
4 checks passed
@alfeilex alfeilex deleted the #590-asciidoc branch October 10, 2024 09:14
@hohwille hohwille added the reviewed Marks PRs that have been presented in the sprint-review meeting or that do not need to be presented. label Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix documentation Improvements or additions to documentation reviewed Marks PRs that have been presented in the sprint-review meeting or that do not need to be presented.
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Documentation has AsciiDoc syntax errors
4 participants