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

Link doc validation error to doc guides #39921

Merged
merged 1 commit into from
Apr 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ public static void main(String[] args) throws Exception {
}
}

errorLog.append("See https://quarkus.io/guides/doc-reference#cross-references");

throw new IllegalStateException(errorLog.toString());
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -406,17 +406,17 @@ private String getMessageforKey(String errorKey) {
case "detached-attributes":
return "The document header ended (blank line) before common attributes were included.";
case "empty-preamble":
return "Document preamble is empty.";
return "Document preamble is empty. See https://quarkus.io/guides/doc-reference#abstracts-preamble";
case "missing-preamble":
return "Document does not have a preamble.";
return "Document does not have a preamble. See https://quarkus.io/guides/doc-reference#abstracts-preamble";
case "summary-too-long":
return "Document summary (either summary attribute or the preamble) is longer than 26 words.";
return "Document summary (either summary attribute or the preamble) is longer than 26 words. See https://quarkus.io/guides/doc-reference#doc-header-optional";
case "missing-id":
return "Document does not define an id.";
return "Document does not define an id. See https://quarkus.io/guides/doc-reference#document-header";
case "missing-categories":
return "Document does not specify associated categories";
return "Document does not specify associated categories. See https://quarkus.io/guides/doc-reference#categories";
case "not-diataxis-type":
return "Document type not recognized. It either does not have a diataxis-type attribute or does not follow naming conventions.";
return "Document type not recognized. It either does not have a diataxis-type attribute or does not follow naming conventions. See https://quarkus.io/guides/doc-reference#document-header";
case "toc":
return "A :toc: attribute is present in the document header (remove it)";
}
Expand Down
Loading