Merge pull request #1636 from SUSE/doc-kit-minvm-update

Doc kit minvm update
SUSE · Dec 22, 2023 · aa79c56 · aa79c56
2 parents 878cc8b + 3d3225b
commit aa79c56
Show file tree

Hide file tree

Showing 8 changed files with 90 additions and 41 deletions.
diff --git a/doc-kit.conf b/doc-kit.conf
@@ -3,12 +3,12 @@ variant: license-gfdl
 
 file: d5aba8356449342d0bac0a62116b85f1b44ee73d  .gitignore
 file: c6b4745307e90c9b88905b434cbbaddc54e4541b  .editorconfig
-file: 81394d2b59e358514b7f798fda881ecd8d3f5873  xml/generic-entities.ent
+file: 1cce617c0f95dd2dd3442220ad4220153cfdac93  xml/generic-entities.ent
 file: a79a3bc929478668955564bab48aecc8502555f6  xml/network-entities.ent
-file: 78cb16c93e8a51b4c9ec32c4b30466b87979fb6a  xml/common_intro_available_doc.xml
+file: bb1883074f56e583475571647a9b724e5e3b5d3f  xml/common_intro_available_doc.xml
 file: 6b82b8fa32f3c8cd8c76e804e420ae4a9312ec27  xml/common_intro_support.xml
-file: 578bc097d6cb4ef8aa08dbf4f1bf4400cae124f6  xml/common_intro_convention.xml
-file: fcb8648dbfbe5a036547347e2affbeb353622162  xml/common_intro_feedback.xml
+file: a7dde5524c60c5ea24fa07a9381fd0111e55bae9  xml/common_intro_convention.xml
+file: 4d21db5e0264bdd166bb8c91b4a1a7ce3ece88c5  xml/common_intro_feedback.xml
 file: 1c8497ffe563b59832de4b0e106082aa4932a528  xml/common_copyright_gfdl.xml
 file: 7022e7485da1b892ea57faf858857981eb3644bc  xml/common_legal.xml
 file: de23bd53cd811ab5e13a39b302f32b16be9956cd  xml/common_license_gfdl1.2.xml
diff --git a/xml/art_minimal-vm.xml b/xml/art_minimal-vm.xml
@@ -9,15 +9,15 @@
  xml:lang="en">
  <info>
   <title>&sle_minvm_guide;</title>
-  <productname>&sls; &minvm;</productname>
+  <productname>&minvm;</productname>
   <productnumber>&productnumber;</productnumber>
   <date><?dbtimestamp format="B d, Y"?></date>
   <dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
    <dm:translation>yes</dm:translation>
   </dm:docmanager>
   <abstract>
    <para>
-    The following document provides an overview of &sls; &minvm; (formerly known
+    The following document provides an overview of &minvm; (formerly known
     as &jeos;) and describes the setup procedure.
    </para>
   </abstract>
@@ -37,7 +37,7 @@
 
   <para>
    If you already have &sls; certification, you are automatically certified for
-   &minvm;, as it is derived from the same code base. &sls; &minvm; allows you to
+   &minvm;, as it is derived from the same code base. &minvm; allows you to
    reduce the operating system to the packages essential for the specific usage
    scenario. This minimizes the number of packages and patches that need to be
    managed and applied. By removing unnecessary packages, you also reduce the
@@ -189,7 +189,7 @@
       <note>
        <title>Specific host tools packages</title>
        <para>
-        Each &sls; &minvm; flavor contains certain host tools packages. Refer to
+        Each &minvm; flavor contains certain host tools packages. Refer to
         the specific flavors section in the documentation for further
         information.
        </para>

diff --git a/xml/common_intro_available_doc.xml b/xml/common_intro_available_doc.xml
@@ -40,6 +40,17 @@
     </note>
    </listitem>
   </varlistentry>
+  <varlistentry>
+   <term>&suse; Knowledgebase</term>
+   <!--based on 'Support Resources' listed at https://www.suse.com/support/kb/-->
+   <listitem>
+    <para>
+     If you have run into an issue, also check out the Technical Information
+     Documents (TIDs) that are available online at <link xlink:href="https://www.suse.com/support/kb/"/>.
+     Search the &suse; Knowledgebase for known solutions driven by customer need.
+     </para>
+   </listitem>
+  </varlistentry>
   <varlistentry condition="suse-product">
    <term>Release notes</term>
    <listitem>

diff --git a/xml/common_intro_convention.xml b/xml/common_intro_convention.xml
@@ -89,18 +89,35 @@
   </listitem>
   <listitem>
    <para>
-    Commands that must be run with &rootuser; privileges. Often you can also
+    Commands that must be run with &rootuser; privileges. You can also
     prefix these commands with the <command>sudo</command> command to run them
-    as non-privileged user.
+    as a non-privileged user:
    </para>
    <screen>&prompt.root;<command>command</command>
 &prompt.sudo;<command>command</command></screen>
   </listitem>
   <listitem>
    <para>
-    Commands that can be run by non-privileged users.
+    Commands that can be run by non-privileged users:
    </para>
 <screen>&prompt.user;<command>command</command></screen>
+  </listitem>
+  <listitem>
+   <para>
+    Commands can be split into two or multiple lines by a backslash character
+    (<literal>\</literal>) at the end of a line. The backslash informs the shell that
+    the command invocation will continue after the line's end:
+   </para>
+   <screen>&prompt.user;<command>echo</command> a b \
+c d</screen>
+  </listitem>
+  <listitem>
+    <para>
+     A code block that shows both the command (preceded by a prompt)
+     and the respective output returned by the shell:
+    </para>
+    <screen>&prompt.user;<command>command</command>
+output</screen>
   </listitem>
   <listitem>
    <para>

diff --git a/xml/common_intro_feedback.xml b/xml/common_intro_feedback.xml
@@ -82,8 +82,7 @@
     </note>
     <para>
      For more information about the documentation environment used for this
-     documentation, see the repository's README at
-     <link xlink:href="&repo-url;"/>.
+     documentation, see the repository's README.
     </para>
    </listitem>
   </varlistentry>

diff --git a/xml/generic-entities.ent b/xml/generic-entities.ent
@@ -57,11 +57,13 @@
 <!-- SUSE PRODUCTS -->
 
 <!ENTITY sliberty               "&suse; Liberty Linux">
+<!ENTITY neuvector              "NeuVector">
+<!ENTITY ranchelemental         "Rancher Elemental">
 
 <!-- SLE -->
 <!ENTITY jeos                   "JeOS"><!-- Just enough OS -->
 <!ENTITY jeosfirstboot          "&jeos; Firstboot">
-<!ENTITY minvm                  "Minimal VM">
+<!ENTITY minvm                  "&slsa; Minimal VM">
 <!ENTITY leanos                 "Unified Installer">
 <!ENTITY sle                    "&suse; Linux Enterprise">
 <!ENTITY sled                   "&sle; Desktop">
@@ -77,13 +79,14 @@
 <!ENTITY sles4sap               "&sls; for &sap; Applications">
 <!ENTITY s4s                    "&sles4sap;">
 <!ENTITY slem                   "&sle; Micro">
-<!ENTITY bci                    "&slea; Base Container Images">
-<!ENTITY bcia                   "&slea; BCI">
-<!ENTITY dinstaller             "Agama">
+<!ENTITY bci-product            "&slea; Base Container Images">
+
 
 <!-- ALP -->
 <!ENTITY alp                    "Adaptable Linux Platform">
 <!ENTITY alpshort               "ALP">
+<!ENTITY alp-dolomite           "&alpshort;&nbsp;Dolomite">
+
 
 <!-- SLE HA -->
 
@@ -181,7 +184,6 @@ use &deng;! -->
 <!ENTITY sap                    "SAP">
 <!ENTITY vmware                 "VMware">
 
-
 <!-- THIRD-PARTY PRODUCTS -->
 
 <!ENTITY hana                   "&sap; HANA">
@@ -271,6 +273,9 @@ use &deng;! -->
 <!ENTITY ad                     "Active Directory">
 <!ENTITY ada                    "AD">
 <!ENTITY aide                   "AIDE">
+<!ENTITY alp-installer          "Agama">
+<!ENTITY dinstaller             "&alp-installer;">
+<!ENTITY ansible                "Ansible">
 <!ENTITY ay                     "AutoYaST">
 <!ENTITY bcache                 "<systemitem xmlns='http://docbook.org/ns/docbook' class='resource'>bcache</systemitem>">
 <!ENTITY chrony                 "<systemitem xmlns='http://docbook.org/ns/docbook' class='resource'>chrony</systemitem>">
@@ -282,12 +287,14 @@ use &deng;! -->
 <!ENTITY grub                   "GRUB&nbsp;2">
 <!ENTITY grub-efi               "GRUB&nbsp;2 for EFI">
 <!ENTITY kdump                  "Kdump">
+<!ENTITY kea                    "Kea">
 <!ENTITY kexec                  "Kexec">
 <!ENTITY kg                     "kGraft">
 <!ENTITY klp                    "Kernel Live Patching">
 <!ENTITY klpa                   "KLP">
 <!ENTITY ulp                    "user space live patching">
 <!ENTITY ulpa                   "ULP">
+<!ENTITY keylime                "Keylime">
 <!ENTITY kiwi                   "KIWI&nbsp;NG">
 <!ENTITY kprobes                "Kprobes">
 <!ENTITY krb                    "Kerberos">
@@ -307,10 +314,12 @@ use &deng;! -->
 <!ENTITY selnx                  "SELinux">
 <!ENTITY smaster                "&salt; Master">
 <!ENTITY sminion                "&salt; Minion">
+<!ENTITY snapper                "Snapper">
 <!ENTITY sudo                   "<command xmlns='http://docbook.org/ns/docbook'>sudo</command>">
 <!ENTITY suseconnect            "SUSEConnect">
-<!ENTITY tr-up                   "<command xmlns='http://docbook.org/ns/docbook'>transactional-update</command>">
-<!ENTITY tr-up-shell             "<command xmlns='http://docbook.org/ns/docbook'>transactional-update shell</command>">
+<!ENTITY tr-up                  "<command xmlns='http://docbook.org/ns/docbook'>transactional-update</command>">
+<!ENTITY tr-up-shell            "<command xmlns='http://docbook.org/ns/docbook'>transactional-update shell</command>">
+<!ENTITY tr-up-run              "<command xmlns='http://docbook.org/ns/docbook'>transactional-update run</command>">
 <!ENTITY xgeneric               "X Window System">
 <!ENTITY xvendor                "X.Org">
 <!ENTITY yast                   "YaST">
@@ -319,6 +328,10 @@ use &deng;! -->
 <!ENTITY yelp                   "Help">
 
 
+<!-- ALP -->
+<!ENTITY fuelignition-dld-site   "https://ignite.opensuse.org">
+<!ENTITY virt-scenario           "<command xmlns='http://docbook.org/ns/docbook'>virt-scenario</command>">
+
 
 <!-- HA -->
 
@@ -357,16 +370,22 @@ use &deng;! -->
 <!ENTITY podman                 "Podman">
 <!ENTITY buildah                "Buildah">
 <!ENTITY k8s                    "Kubernetes">
+<!ENTITY bci                    "&slea; Base Container Image">
+<!ENTITY bcia                   "&slea; BCI">
+<!ENTITY netavark               "Netavark">
 
 
 
 <!-- VIRTUALIZATION -->
 
+<!ENTITY amdsev                 "AMD SEV">
 <!ENTITY dom0                   "Dom0">
 <!ENTITY esx                    "&vmware; ESX">
 <!ENTITY gpuback                "GPU Pass-Through">
 <!ENTITY hyperv                 "&ms; Hyper-V">
 <!ENTITY kvm                    "KVM">
+<!ENTITY kvmserver              "&kvm; Server">
+<!ENTITY kvmclient              "&kvm; Client">
 <!ENTITY libvirt                "<systemitem xmlns='http://docbook.org/ns/docbook' class='library'>libvirt</systemitem>">
 <!ENTITY pciback                "PCI Pass-Through">
 <!ENTITY qemu                   "QEMU">
@@ -425,6 +444,7 @@ use &deng;! -->
 
 
 
+
 <!-- HARDWARE TECHNOLOGIES -->
 
 <!ENTITY nvme                   "NVMe">
@@ -449,6 +469,8 @@ use &deng;! -->
 <!ENTITY usbflashdrive          "USB flash drive">
 <!ENTITY usbflashdrivecap       "USB Flash Drive">
 
+<!ENTITY infiniband              "InfiniBand">
+
 
 <!-- NETWORK PROTOCOLS -->
 <!ENTITY ptp             "Precision Time Protocol">
@@ -476,6 +498,8 @@ use &deng;! -->
 
 <!ENTITY iscsi                  "iSCSI">
 <!ENTITY netteam                "Network Teaming">
+<!ENTITY opensm                 "opensm">
+<!ENTITY subnetmanager          "Subnet Manager">
 
 
 
@@ -533,28 +557,26 @@ use &deng;! -->
 
 
 
-<!-- CHARACTER ENTITIES -->
-
-<!ENTITY euro                   "&#x20AC;">
-<!ENTITY thrdmrk                "*">
-
-
 <!-- DOCBOOK 4 ENTITITES -->
 
-<!ENTITY dash             "&#x02010;" ><!--HYPHEN -->
-<!ENTITY ndash            "&#x02013;" ><!--EN DASH -->
-<!ENTITY mdash            "&#x02014;" ><!--EM DASH -->
-<!ENTITY trade            "&#x02122;" ><!--TRADE MARK SIGN -->
+<!ENTITY ast              "&#x0002A;" ><!--ASTERISK -->
+<!ENTITY asymp            "&#x02248;" ><!--ALMOST EQUAL TO -->
+<!ENTITY checkmark        "&#x02714;" ><!--HEAVY CHECK MARK-->
+<!ENTITY commat           "&#x00040;" ><!--COMMERCIAL AT -->
 <!ENTITY copy             "&#x000A9;" ><!--COPYRIGHT SIGN -->
-<!ENTITY sol              "&#x0002F;" ><!--SOLIDUS -->
-<!ENTITY rdquo            "&#x0201D;" ><!--RIGHT DOUBLE QUOTATION MARK -->
+<!ENTITY dash             "&#x02010;" ><!--HYPHEN -->
+<!ENTITY euro             "&#x020AC;" ><!--EURO SIGN -->
+<!ENTITY hellip           "&#x02026;" ><!--HORIZONTAL ELLIPSIS -->
 <!ENTITY ldquo            "&#x0201C;" ><!--LEFT DOUBLE QUOTATION MARK -->
+<!ENTITY mdash            "&#x02014;" ><!--EM DASH -->
 <!ENTITY nbsp             "&#x000A0;" ><!--NO-BREAK SPACE -->
+<!ENTITY ndash            "&#x02013;" ><!--EN DASH -->
+<!ENTITY rdquo            "&#x0201D;" ><!--RIGHT DOUBLE QUOTATION MARK -->
 <!ENTITY reg              "&#x000AE;" ><!--REGISTERED SIG -->
-<!ENTITY hellip           "&#x02026;" ><!--HORIZONTAL ELLIPSIS -->
-<!ENTITY asymp            "&#x02248;" ><!--ALMOST EQUAL TO -->
-<!ENTITY ast              "&#x0002A;" ><!--ASTERISK -->
-<!ENTITY commat           "&#x00040;" ><!--COMMERCIAL AT -->
+<!ENTITY sol              "&#x0002F;" ><!--SOLIDUS -->
+<!ENTITY thrdmrk          "*"         ><!--ASTERISK -->
+<!ENTITY trade            "&#x02122;" ><!--TRADE MARK SIGN -->
+
 <!-- LEGACY COMPATIBILITY ENTITIES -->
 <!-- Do not use in new documentation. -->
 
@@ -599,4 +621,4 @@ use &deng;! -->
 <!ENTITY smtguide              "Subscription Management Tool Guide">
 
 <!-- SLE HA, old productname entity -->
-<!ENTITY hasi                   "&ha;">
+<!ENTITY hasi                   "&ha;">
diff --git a/xml/rmt_install.xml b/xml/rmt_install.xml
@@ -94,7 +94,7 @@
     <sect2 xml:id="sec-rmt-installation-zypper-jeos">
       <title>Installation on &minvm;</title>
       <para>
-        &sls; &minvm; is a minimal customizable operating system that is
+        &minvm; is a minimal customizable operating system that is
         designed for specific usage scenarios, for example, to be run as:
       </para>
       <itemizedlist>
@@ -121,7 +121,7 @@
       </itemizedlist>
       <para>
         &minvm; image is a good choice for being used as an &rmt; server. You
-        can download &sls; &minvm; images for &kvm;, &xen;, &hyperv;, &vmware;,
+        can download &minvm; images for &kvm;, &xen;, &hyperv;, &vmware;,
         and OpenStack from the public &sls; download page at
         <link
    xlink:href="https://www.suse.com/download/sles/"/>. Find more

diff --git a/xml/software_management.xml b/xml/software_management.xml
@@ -115,9 +115,9 @@
    </para>
 
    <tip os="sles;sled;slemicro">
-    <title>&slsa; &minvm;</title>
+    <title>&minvm;</title>
     <para>
-     The &sls; download page offers preconfigured and ready-to-run &slsa; &minvm; virtual machine images. &slsa; &minvm; has a small footprint and can be customized to fit specific needs of a system developer. &minvm; is designed for use in virtual machines and for virtual software appliance development. The key benefits of &slsa; &minvm; are efficiency and simplified management. More information about &minvm; is available in the dedicated guide. If &slsa; &minvm; does not meet your requirements, consider the minimal installation pattern.
+     The &sls; download page offers preconfigured and ready-to-run &minvm; virtual machine images. &minvm; has a small footprint and can be customized to fit specific needs of a system developer. &minvm; is designed for use in virtual machines and for virtual software appliance development. The key benefits of &minvm; are efficiency and simplified management. More information about &minvm; is available in the dedicated guide. If &minvm; does not meet your requirements, consider the minimal installation pattern.
     </para>
    </tip>