Update docs for main

Signed-off-by: kubevirt-bot <kubevirtbot@redhat.com>
2026-07-28 18:34:36 +00:00 · 2024-05-17 09:27:36 +00:00
parent 58d812b228
commit d7cde70601
9 changed files with 207 additions and 205 deletions
--- a/main/plugins/kubevirt_vm_info.html
+++ b/main/plugins/kubevirt_vm_info.html
@@ -131,8 +131,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
 <section id="synopsis">
 <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
 <ul class="simple">
-<li><p>Use the Kubernetes Python client to perform read operations on KubeVirt VirtualMachines.</p></li>
-<li><p>Pass options to find VirtualMachines as module arguments.</p></li>
+<li><p>Use the Kubernetes Python client to perform read operations on KubeVirt <code class="docutils literal notranslate"><span class="pre">VirtualMachines</span></code>.</p></li>
+<li><p>Pass options to find <code class="docutils literal notranslate"><span class="pre">VirtualMachines</span></code> as module arguments.</p></li>
 <li><p>Authenticate using either a config file, certificates, password or token.</p></li>
 <li><p>Supports check mode.</p></li>
 </ul>
@@ -252,7 +252,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    </p>
  </div></td>
  <td><div class="ansible-option-cell">
-    <p>List of field selectors to use to filter results</p>
+    <p>List of field selectors to use to filter results.</p>
    <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">[]</code></p>
  </div></td>
 </tr>
@@ -326,7 +326,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    </p>
  </div></td>
  <td><div class="ansible-option-cell">
-    <p>List of label selectors to use to filter results</p>
+    <p>List of label selectors to use to filter results.</p>
    <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">[]</code></p>
  </div></td>
 </tr>
@@ -340,7 +340,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    </p>
  </div></td>
  <td><div class="ansible-option-cell">
-    <p>Specify the name of the VirtualMachine.</p>
+    <p>Specify the name of the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
  </div></td>
 </tr>
 <tr class="row-odd">
@@ -353,7 +353,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    </p>
  </div></td>
  <td><div class="ansible-option-cell">
-    <p>Specify the namespace of VirtualMachines.</p>
+    <p>Specify the namespace of <code class='docutils literal notranslate'>VirtualMachines</code>.</p>
  </div></td>
 </tr>
 <tr class="row-even">
@@ -493,9 +493,9 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    <p><em class="ansible-option-versionadded">added in kubevirt.core 1.4.0</em></p>
  </div></td>
  <td><div class="ansible-option-cell">
-    <p>Specify whether the VirtualMachine should be running.</p>
+    <p>Specify whether the <code class='docutils literal notranslate'>VirtualMachine</code> should be running or not.</p>
    <p>This affects the ready condition to wait for.</p>
-    <p>This requires <code class='docutils literal notranslate'>wait</code> and is only used when <em>wait=yes</em>.</p>
+    <p>This requires <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-wait"><span class="std std-ref"><span class="pre">wait=yes</span></span></a></code>.</p>
    <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
    <ul class="simple">
      <li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">false</code></p></li>
@@ -549,9 +549,9 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    </p>
  </div></td>
  <td><div class="ansible-option-cell">
-    <p>Whether to wait for the VirtualMachine to end up in the ready state.</p>
-    <p>By default this is waiting for the VirtualMachine to be up and running.</p>
-    <p>Modify this behavior by setting <code class='docutils literal notranslate'>running</code>.</p>
+    <p>Whether to wait for the <code class='docutils literal notranslate'>VirtualMachine</code> to end up in the ready state.</p>
+    <p>By default this is waiting for the <code class='docutils literal notranslate'>VirtualMachine</code> to be up and running.</p>
+    <p>Modify this behavior by setting <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-running"><span class="std std-ref"><span class="pre">running</span></span></a></strong></code>.</p>
    <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
    <ul class="simple">
      <li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">false</code></p></li>
@@ -571,7 +571,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
  </div></td>
  <td><div class="ansible-option-cell">
    <p>Number of seconds to sleep between checks.</p>
-    <p>Ignored if <code class='docutils literal notranslate'>wait</code> is not set.</p>
+    <p>Ignored if <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-wait"><span class="std std-ref"><span class="pre">wait</span></span></a></strong></code> is not set.</p>
    <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">5</code></p>
  </div></td>
 </tr>
@@ -585,8 +585,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    </p>
  </div></td>
  <td><div class="ansible-option-cell">
-    <p>How long in seconds to wait for the resource to end up in the desired state.</p>
-    <p>Ignored if <code class='docutils literal notranslate'>wait</code> is not set.</p>
+    <p>How long in seconds to wait for the resource to end up in the ready state.</p>
+    <p>Ignored if <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-wait"><span class="std std-ref"><span class="pre">wait</span></span></a></strong></code> is not set.</p>
    <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">120</code></p>
  </div></td>
 </tr>
@@ -659,7 +659,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    </p>
  </div></td>
  <td><div class="ansible-option-cell">
-    <p>Whether the specified api_version and VirtualMachine kind were successfully mapped to an existing API on the targeted cluster.</p>
+    <p>Whether the specified <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-api_version"><span class="std std-ref"><span class="pre">api_version</span></span></a></strong></code> and <code class='docutils literal notranslate'>VirtualMachine</code> <code class='docutils literal notranslate'>Kind</code> were successfully mapped to an existing API on the target cluster.</p>
    <p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
  </div></td>
 </tr>
@@ -673,7 +673,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    </p>
  </div></td>
  <td><div class="ansible-option-cell">
-    <p>The VirtualMachine(s) that exist(s)</p>
+    <p>The <code class='docutils literal notranslate'>VirtualMachines</code> that exist.</p>
    <p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
  </div></td>
 </tr>
@@ -701,7 +701,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    </p>
  </div></td>
  <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
-    <p>Represents the REST resource this object represents.</p>
+    <p>Represents the <code class='docutils literal notranslate'>REST</code> resource this object represents.</p>
    <p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
  </div></td>
 </tr>
@@ -729,7 +729,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    </p>
  </div></td>
  <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
-    <p>Specific attributes of the VirtualMachine. Can vary based on the <em>api_version</em>.</p>
+    <p>Specific attributes of the <code class='docutils literal notranslate'>VirtualMachine</code>. Can vary based on the <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-api_version"><span class="std std-ref"><span class="pre">api_version</span></span></a></strong></code>.</p>
    <p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
  </div></td>
 </tr>
@@ -743,7 +743,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    </p>
  </div></td>
  <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
-    <p>Current status details for the VirtualMachine.</p>
+    <p>Current status details for the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
    <p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
  </div></td>
 </tr>