diff --git a/modules/ungood_module.adoc b/modules/ungood_module.adoc new file mode 100644 index 000000000000..40718044fd3a --- /dev/null +++ b/modules/ungood_module.adoc @@ -0,0 +1,66 @@ +// NO parent assembly comment - violates ModuleContainsParentAssemblyComment +[id="problematic-vale-test"] += Problematic Vale Test Module +John Smith + +This module is missing EVERYTHING. + +No short description with [role="_abstract"] - violates ShortDescription. + +No _mod-docs-content-type variable - violates ModuleContainsContentType. + +ID missing _{context} - violates IdHasContextVariable. + +.NOTE: This is an admonition title +NOTE: Admonition titles are not supported - violates AdmonitionTitle. + +== Nested Section Inside Module +This violates NoNestingInModules - modules should not have section headings. + +=== Doubly Nested Section +Even worse nesting. + +.Additional resources +This additional resources section is missing the role attribute - violates AdditionalResourcesHeadingHasRoleID. + +* xref:some-other-file.adoc[A naked xref label] - violates XrefMustNotHaveNakedLabel +* xref:another-file#some-anchor[Link] - this xref contains HTML-style anchor - violates XrefContainsHTML +* link:https://example.com[Click here] - external link in a module + +include::snippets/some-snippet.adoc[lines=1..5] + +[source,terminal] +---- +oc get pods +---- + +This is a line that is exactly eighty characters long and ends without punctuat +This continues on a new line - violates HardWrappedLines. + +Here is a thematic break which is not supported: + +''' + +And a page break: + +<<< + +Some text with {custom-attribute-reference} that might not resolve. + +[sidebar] +This is a sidebar block which is not supported in DITA. + +---- +This is a listing block +with a trailing backslash \ +which might cause issues +---- + +.Example block title +==== +Example blocks need special handling. +==== + +toc::[] + +