-
Notifications
You must be signed in to change notification settings - Fork 1.8k
[NEVERMERGE] Add a purposefully bad module #104108
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| // NO parent assembly comment - violates ModuleContainsParentAssemblyComment | ||
| [id="problematic-vale-test"] | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] OpenShiftAsciiDoc.IdHasContextVariable: ID is missing the '_{context}' variable at the end of the ID. |
||
| = Problematic Vale Test Module | ||
| John Smith <jsmith@example.com> | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.AuthorLine: Author lines are not supported for topics. |
||
|
|
||
| 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 | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.AdmonitionTitle: Admonition titles are not supported in DITA.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA. |
||
| NOTE: Admonition titles are not supported - violates AdmonitionTitle. | ||
|
|
||
| == Nested Section Inside Module | ||
| This violates NoNestingInModules - modules should not have section headings. | ||
|
|
||
| === Doubly Nested Section | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections are not supported in DITA. |
||
| Even worse nesting. | ||
|
|
||
| .Additional resources | ||
| This additional resources section is missing the role attribute - violates AdditionalResourcesHeadingHasRoleID. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
|
|
||
| * xref:some-other-file.adoc[A naked xref label] - violates XrefMustNotHaveNakedLabel | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] OpenShiftAsciiDoc.XrefContainsAnchorID: The xref is missing an anchor ID. |
||
| * xref:another-file#some-anchor[Link] - this xref contains HTML-style anchor - violates XrefContainsHTML | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
| * link:https://example.com[Click here] - external link in a module | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
|
|
||
| include::snippets/some-snippet.adoc[lines=1..5] | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] OpenShiftAsciiDoc.NoLineRanges: Do not use line ranges for included files. |
||
|
|
||
| [source,terminal] | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
| ---- | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
| oc get pods | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
| ---- | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
|
|
||
| This is a line that is exactly eighty characters long and ends without punctuat | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
| This continues on a new line - violates HardWrappedLines. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
|
|
||
| Here is a thematic break which is not supported: | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
|
|
||
| ''' | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.ThematicBreak: Thematic breaks are not supported in DITA.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
|
|
||
| And a page break: | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
|
|
||
| <<< | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.PageBreak: Page breaks are not supported in DITA.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
|
|
||
| Some text with {custom-attribute-reference} that might not resolve. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
|
|
||
| [sidebar] | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.SidebarBlock: Sidebars are not supported in DITA.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
| This is a sidebar block which is not supported in DITA. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
|
|
||
| ---- | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
| This is a listing block | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
| with a trailing backslash \ | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
| which might cause issues | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
| ---- | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links. |
||
|
|
||
| .Example block title | ||
| ==== | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.ExampleBlock: Examples can not be inside of other blocks in DITA. |
||
| Example blocks need special handling. | ||
| ==== | ||
|
|
||
| toc::[] | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] OpenShiftAsciiDoc.NoTocInModules: Do not include TOCs in modules, only assemblies. |
||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤖 [error] AsciiDocDITA.ContentType: The '_mod-docs-content-type' attribute definition is missing.