Issue #17865: new xdoc xml page to share with users how to download xsd #18054
Conversation
|
GitHub, generate website |
|
GitHub, generate website |
|
|
GitHub, generate website |
Sure, i have added it. let's see how it looks and what further changes we can make in it. |
src/site/xdoc/xsds.xml
Outdated
| @@ -0,0 +1,55 @@ | |||
| <?xml version="1.0" encoding="UTF-8"?> | |||
There was a problem hiding this comment.
I don't see value in this page.
Please remove.
Report xsd is not configuration, link to xsd of configuration we already have in section where we describe config structure
src/site/xdoc/result_report.xml
Outdated
| </p> | ||
| </section> | ||
|
|
||
| <section name="Schema"> |
There was a problem hiding this comment.
Please name it "Xml report" section and combine following example section into this section.
So in future there will be section for all reports, but not in this PR.
src/site/xdoc/result_report.xml
Outdated
|
|
||
| <section name="Overview"> | ||
| <p> | ||
| Checkstyle can generate XML reports of its findings. These reports |
There was a problem hiding this comment.
Checkstyle can generate XML, SARIF and plain text reports of its findings.
Reference to xsd should be moved to xml report section
|
GitHub, generate website |
|
Yes, good. Please fix CI |
Part of Issue #17867 , Comment #17865 (comment)
This change adds a new page to the Checkstyle website where users can find and download the XSD files for validating configuration files and report outputs.
What I Did
Made a new file
src/site/xdoc/xsds.xmlthat lists the XSDs with links to download them.Added "XSD Schemas" to the menu under "Configuration" in
src/site/site.xml.Why
Users need a way to get the XSDs easily, just like the DTDs.
The XSDs are already set to be copied to the site by the build process.
This page explains how to use them in XML files.
The new page shows up at
target/site/xsds.htmlwith working links to the XSD files.