[NEVERMERGE] Add a purposefully bad module #104108

maxwelldb · 2025-12-17T22:45:59Z

This file must never be merged.

ocpdocs-previewbot · 2025-12-17T22:54:43Z

🤖 Fri Dec 19 22:15:59 - Prow CI generated the docs preview:

https://104108--ocpdocs-pr.netlify.app/

maxwelldb · 2025-12-17T23:01:48Z

/retest

ocpdocs-vale-bot · 2025-12-19T21:47:14Z

modules/ungood_module.adoc

🤖 [error] AsciiDocDITA.ContentType: The '_mod-docs-content-type' attribute definition is missing.

ocpdocs-vale-bot · 2025-12-19T21:47:15Z

modules/ungood_module.adoc

🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.

ocpdocs-vale-bot · 2025-12-19T21:47:17Z

modules/ungood_module.adoc

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

ocpdocs-vale-bot · 2025-12-19T21:47:19Z

modules/ungood_module.adoc

@@ -0,0 +1,66 @@
+// NO parent assembly comment - violates ModuleContainsParentAssemblyComment
+[id="problematic-vale-test"]


🤖 [error] OpenShiftAsciiDoc.IdHasContextVariable: ID is missing the '_{context}' variable at the end of the ID.

ocpdocs-vale-bot · 2025-12-19T21:47:20Z

modules/ungood_module.adoc

+// NO parent assembly comment - violates ModuleContainsParentAssemblyComment
+[id="problematic-vale-test"]
+= Problematic Vale Test Module
+John Smith <jsmith@example.com>


🤖 [error] AsciiDocDITA.AuthorLine: Author lines are not supported for topics.

ocpdocs-vale-bot · 2025-12-19T21:47:22Z

modules/ungood_module.adoc

+
+ID missing _{context} - violates IdHasContextVariable.
+
+.NOTE: This is an admonition title


🤖 [error] AsciiDocDITA.AdmonitionTitle: Admonition titles are not supported in DITA.

ocpdocs-vale-bot · 2025-12-19T21:47:24Z

modules/ungood_module.adoc

+
+ID missing _{context} - violates IdHasContextVariable.
+
+.NOTE: This is an admonition title


🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.

ocpdocs-vale-bot · 2025-12-19T21:47:25Z

modules/ungood_module.adoc

+== Nested Section Inside Module
+This violates NoNestingInModules - modules should not have section headings.
+
+=== Doubly Nested Section


🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections are not supported in DITA.

ocpdocs-vale-bot · 2025-12-19T21:47:27Z

modules/ungood_module.adoc

+Even worse nesting.
+
+.Additional resources
+This additional resources section is missing the role attribute - violates AdditionalResourcesHeadingHasRoleID.


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:29Z

modules/ungood_module.adoc

+.Additional resources
+This additional resources section is missing the role attribute - violates AdditionalResourcesHeadingHasRoleID.
+
+* xref:some-other-file.adoc[A naked xref label] - violates XrefMustNotHaveNakedLabel


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:30Z

modules/ungood_module.adoc

+.Additional resources
+This additional resources section is missing the role attribute - violates AdditionalResourcesHeadingHasRoleID.
+
+* xref:some-other-file.adoc[A naked xref label] - violates XrefMustNotHaveNakedLabel


🤖 [error] OpenShiftAsciiDoc.XrefContainsAnchorID: The xref is missing an anchor ID.

ocpdocs-vale-bot · 2025-12-19T21:47:32Z

modules/ungood_module.adoc

+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


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:34Z

modules/ungood_module.adoc

+
+* 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


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:35Z

modules/ungood_module.adoc

+* 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]


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:37Z

modules/ungood_module.adoc

+* 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]


🤖 [error] OpenShiftAsciiDoc.NoLineRanges: Do not use line ranges for included files.

ocpdocs-vale-bot · 2025-12-19T21:47:39Z

modules/ungood_module.adoc

+
+include::snippets/some-snippet.adoc[lines=1..5]
+
+[source,terminal]


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:40Z

modules/ungood_module.adoc

+include::snippets/some-snippet.adoc[lines=1..5]
+
+[source,terminal]
+----


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:42Z

modules/ungood_module.adoc

+
+[source,terminal]
+----
+oc get pods


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:44Z

modules/ungood_module.adoc

+[source,terminal]
+----
+oc get pods
+----


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:45Z

modules/ungood_module.adoc

+oc get pods
+----
+
+This is a line that is exactly eighty characters long and ends without punctuat


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:47Z

modules/ungood_module.adoc

+----
+
+This is a line that is exactly eighty characters long and ends without punctuat
+This continues on a new line - violates HardWrappedLines.


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:49Z

modules/ungood_module.adoc

+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:


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:50Z

modules/ungood_module.adoc

+
+Here is a thematic break which is not supported:
+
+'''


🤖 [error] AsciiDocDITA.ThematicBreak: Thematic breaks are not supported in DITA.

ocpdocs-vale-bot · 2025-12-19T21:47:52Z

modules/ungood_module.adoc

+
+Here is a thematic break which is not supported:
+
+'''


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:54Z

modules/ungood_module.adoc

+
+'''
+
+And a page break:


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:55Z

modules/ungood_module.adoc

+
+And a page break:
+
+<<<


🤖 [error] AsciiDocDITA.PageBreak: Page breaks are not supported in DITA.

ocpdocs-vale-bot · 2025-12-19T21:47:57Z

modules/ungood_module.adoc

+
+And a page break:
+
+<<<


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:47:59Z

modules/ungood_module.adoc

+
+<<<
+
+Some text with {custom-attribute-reference} that might not resolve.


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:48:00Z

modules/ungood_module.adoc

+
+Some text with {custom-attribute-reference} that might not resolve.
+
+[sidebar]


🤖 [error] AsciiDocDITA.SidebarBlock: Sidebars are not supported in DITA.

ocpdocs-vale-bot · 2025-12-19T21:48:02Z

modules/ungood_module.adoc

+
+Some text with {custom-attribute-reference} that might not resolve.
+
+[sidebar]


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:48:04Z

modules/ungood_module.adoc

+Some text with {custom-attribute-reference} that might not resolve.
+
+[sidebar]
+This is a sidebar block which is not supported in DITA.


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:48:05Z

modules/ungood_module.adoc

+[sidebar]
+This is a sidebar block which is not supported in DITA.
+
+----


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:48:07Z

modules/ungood_module.adoc

+This is a sidebar block which is not supported in DITA.
+
+----
+This is a listing block


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:48:09Z

modules/ungood_module.adoc

+
+----
+This is a listing block
+with a trailing backslash \


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:48:11Z

modules/ungood_module.adoc

+----
+This is a listing block
+with a trailing backslash \
+which might cause issues


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:48:12Z

modules/ungood_module.adoc

+This is a listing block
+with a trailing backslash \
+which might cause issues
+----


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-19T21:48:14Z

modules/ungood_module.adoc

+----
+
+.Example block title
+====


🤖 [error] AsciiDocDITA.ExampleBlock: Examples can not be inside of other blocks in DITA.

ocpdocs-vale-bot · 2025-12-19T21:48:16Z

modules/ungood_module.adoc

+Example blocks need special handling.
+====
+
+toc::[]


🤖 [error] OpenShiftAsciiDoc.NoTocInModules: Do not include TOCs in modules, only assemblies.

openshift-ci · 2025-12-19T22:16:40Z

@maxwelldb: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Add a purposefully bad module

23971cb

This file must never be merged.

openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 17, 2025

maxwelldb closed this Dec 17, 2025

maxwelldb reopened this Dec 17, 2025

maxwelldb closed this Dec 17, 2025

maxwelldb reopened this Dec 17, 2025

maxwelldb mentioned this pull request Dec 18, 2025

[prow/ci] attempt to use file-level comments for vale's 1:1 errors #104109

Merged

openshift deleted a comment from ocpdocs-vale-bot Dec 19, 2025

maxwelldb closed this Dec 19, 2025

maxwelldb reopened this Dec 19, 2025

ocpdocs-vale-bot reviewed Dec 19, 2025

View reviewed changes

maxwelldb closed this Dec 19, 2025

maxwelldb reopened this Dec 19, 2025

		@@ -0,0 +1,66 @@
		// NO parent assembly comment - violates ModuleContainsParentAssemblyComment
		[id="problematic-vale-test"]


		ID missing _{context} - violates IdHasContextVariable.

		.NOTE: This is an admonition title


		include::snippets/some-snippet.adoc[lines=1..5]

		[source,terminal]


		<<<

		Some text with {custom-attribute-reference} that might not resolve.


		Some text with {custom-attribute-reference} that might not resolve.

		[sidebar]


		'''

		And a page break:

[NEVERMERGE] Add a purposefully bad module #104108

Are you sure you want to change the base?

[NEVERMERGE] Add a purposefully bad module #104108

Conversation

maxwelldb commented Dec 17, 2025

Uh oh!

ocpdocs-previewbot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

maxwelldb commented Dec 17, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

ocpdocs-previewbot commented Dec 17, 2025 •

edited

Loading