Docs: htmlSanityCheck finds several issues

[ascheman]

Question: Is the generated HTML Sanity Check report of the project serving as an example how the checker finds/reports issues? The report is tagged as "Demo-Report":

In this case, please ignore this issue.

Found issues

However, the report currently contains a lot of issues. These can be categorized into

• some real problems (to be solved?), eg.,
  • https://farenda.com/
  • Github Gradle Project
• missing links to generated arc42 PDFs (see below)
• Links to create new GH issues (currently) return a HTTP 429 - Too Many Requests - should this be ignored?
• Warnings resulting in HTTP 301 - Moved Permanently - should this be ignored or fixed?

Check for missing PDFs?

The missing PDF links are probably false positives. PDFs are generated (by dtcw generatePdf) to build/pdf. Links to PDFs in the arc42 documentation are generated relatively, e.g., to ../pdf/arc42/hsc_arc42.pdf. Later everything is copied to public/output and then published as GH pages. Thereby different levels of generated output is merged to the same directory tree level in public/output, e.g., build/microsite/output/arc42 becoming public/output/arc42. Hence, the resulting/published HTMLs finally contain correct links to the PDFs. However, the dtcw htmlSanityCheck is executed on the build/microsite directory. Therefore the PDFs cannot be found and the check contains errors.

[ascheman]

Was resolved in the course of #332