592: checking for correct assembly metadata - WIP #662
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
🎊 Navigate the preview: https://redhat-documentation-vale-at-red-hat-662.surge.sh 🎊 |
|
Click here to review and test in web IDE: |
rohennes
force-pushed
the
592-assembly-metadata
branch
2 times, most recently
from
0967d95 to
289ae46
Compare
rohennes
force-pushed
the
592-assembly-metadata
branch
from
289ae46 to
d14aa36
Compare
aireilly
reviewed
Nov 3, 2023
| @@ -0,0 +1,37 @@ | |||
| --- | |||
| extends: script | |||
| message: "Assembly is missing required metadata. Ensure you include metadata for attributes, TOC and context." | |||
There was a problem hiding this comment.
Suggested change
| message: "Assembly is missing required metadata. Ensure you include metadata for attributes, TOC and context." | |
| message: "Assembly is missing required metadata and AsciiDoc toc elements. Ensure that you include common-attributes.adoc, toc::[], and :context: attributes." |
aireilly
reviewed
Nov 3, 2023
There was a problem hiding this comment.
General comment. The rule as is implemented here catches the various errors but does not tell you which element is missing. This might be confusing for inexperienced users.
What about a series of rules, one for each element we want to police?
then we could do something like this (for example):
extends: occurrence
message: 'Assembly should have a single "toc::[]" directive'
level: error
scope: raw
min: 1
max: 1
token: toc::\[\]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #592
WIP - do not merge