Uploaded image for project: 'OpenShift Virtualization'
  1. OpenShift Virtualization
  2. CNV-58842

Add <shortdesc> to Live Migration sections

XMLWordPrintable

    • Product / Portfolio Work
    • 2
    • False
    • Hide

      None

      Show
      None
    • False
    • None
    • Yes
    • 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:

       

      12.3.1. Initiating live migration

      https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html-single/virtualization/index#initating-live-migration_initiating-canceling

       

      12.3.2. Canceling live migration

      https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html-single/virtualization/index#canceling-live-migration_initiating-canceling

       

       

      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.

       

      <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>

       

              rhn-support-vathakur Vaishali Thakur
              rhn-support-sjess Sabrina Jess
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated: