Admonition and issue use
The Asciidoc documentation gives guidance on how to write different types of semantic content. This section attempts to offer guidance on when to use specific elements.
Admonitions
The Asciidoc documentation does explain the difference between Caution and Warning. We expand on that, inspired by other documentation guidelines.
Neutral information |
|||||
---|---|---|---|---|---|
|
|||||
Positive consequences |
Negative consequences |
||||
|
|
||||
|
|
Feedback messages
Logging levels and feedback message types.
Type |
Log level |
Severity level |
Meaning |
---|---|---|---|
Default |
- |
- |
No specific meaning |
Success |
- |
- |
No problems encountered. |
Critical |
Fatal |
Critical |
Problem that prevents further operation and may result in other damage. |
Danger |
Error |
Major |
Problem that prevents further operation. |
Warning |
Warning |
Minor |
Potential problem but operation continues. |
Note |
Info |
- |
Relevant contextual information to monitor progress or results. |
Tip |
- |
- |
Possible improvement or additional information. |
Diagnostic |
Debug, trace |
- |
Detailed diagnostic information, usually aimed at developers. |