-
Story
-
Resolution: Done
-
Normal
-
None
Follow [DITA guidelines|https://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/langRef/base/shortdesc.html] to add a short description to the following sections:
2.1. OpenShift Virtualization release notes
2.1.5. Deprecated and removed features
- https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html-single/virtualization/index#virt-4-18-deprecated-removed (write intro and/or make sections separate)
Guiding template for creating a <shortdesc>:
The <shortdesc> is a brief summary (ideally 1–2 sentences) that appears immediately after the title. It helps readers quickly understand what the topic covers.
For example:
The release notes summarize the new features and enhancements, notable technical changes, and known bugs with this release of OpenShift Virtualization.
<shortdesc>
[What the user can do] with [the product, feature, or process], including [key value or outcome].
</shortdesc>
Example test.adoc file:
In this case, you could include the short description without including a paragraph containing a full abstract.
:_mod-docs-content-type: CONCEPT [id="topic-id"] = Topic title [role="_abstract"] Short description. First paragraph.
Example DITA output:
$ asciidoctor -r dita-topic -b dita-topic test.adoc -o - | dita-convert -g <?xml version="1.0"?> <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> <concept id="topic-id"> <title>Topic title</title> <shortdesc>Short description.</shortdesc> <conbody> <p>First paragraph.</p> </conbody> </concept>