Skip to content

Commit 63bd95c

Browse files
committed
Describe validation in the readme
1 parent d782020 commit 63bd95c

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,29 @@ The `newdoc` tool generates pre-populated module and assembly files formatted wi
9595
Alternatively, you can use the `--include-in` option when creating the assembly to generate modules and include them automatically, in a single step. See the description in the *Options* section.
9696
9797
98+
## Validating a file for Red Hat requirements
9899
99-
## Options
100+
You can use the `--validate` (`-l`) option to check an existing file for Red Hat publishing requirements. For example:
101+
102+
```
103+
$ newdoc --validate modules/empty-file.adoc
100104

105+
💾 File: empty-file.adoc
106+
🔴 Error: The file has no title or headings.
107+
🔴 Error: The file is missing an ID.
108+
🔶 Warning: The file is missing the _abstract flag. The flag is recommended but not required.
109+
🔴 Error: Cannot determine the module type.
110+
```
111+
112+
```
113+
$ newdoc --validate modules/con_proper-module.adoc
114+
115+
💾 File: modules/con_proper-module.adoc
116+
🔷 Information: No issues found in this file.
117+
```
118+
119+
120+
## Options
101121
102122
* To generate the file without the explanatory comments, add the `--no-comments` or `-C` option when creating documents.
103123

0 commit comments

Comments
 (0)