Applied the new structure. Fixed duplicate titles. Added an abstract …

…to the assembly file.
SUSE · Mar 28, 2023 · 1538a95 · 1538a95
1 parent a3a0162
commit 1538a95
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 29 deletions.
diff --git a/DC-SLE-Micro-public-cloud b/DC-SLE-Micro-public-cloud
@@ -3,8 +3,8 @@
 ## ----------------------------
 ##
 ## Basics
-MAIN="SLE_Micro.asm.xml"
-#SRC_DIR="articles"
+MAIN="SLE_Micro_cloud.asm.xml"
+SRC_DIR="articles"
 
 ## Profiling
 PROFOS="slemicro"

diff --git a/xml/SLE_Micro.asm.xml → articles/SLE_Micro_cloud.asm.xml b/xml/SLE_Micro.asm.xml → articles/SLE_Micro_cloud.asm.xml
@@ -3,7 +3,7 @@
 <?xml-model href="http://docbook.org/xml/5.2/sch/assembly.sch" type="application/xml" schematypens="http://purl.oclc.org/dsdl/schematron"?>
 <!DOCTYPE assembly
 [
-    <!ENTITY % entities SYSTEM "generic-entities.ent">
+    <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
     %entities;
 ]>
 <assembly version="5.2" xml:lang="en"
@@ -26,30 +26,34 @@
 -->
   <resources>
     <description>Concepts</description>
-    <resource xml:id="_concept-micro-cloud" href="concept-micro-cloud.xml"/>
+    <resource xml:id="_micro-cloud" href="../concepts/micro-cloud.xml"/>
+   <!-- Not in use right now
     <resource xml:id="_concept-transactional-update" href="concept-transactional-update.xml"/>
+  -->
     </resources>
-  <resources>
+  <!-- <resources>
     <description>References</description>
     <resource xml:id="_ref-transactional-update-usage" href="reference-transactional-update-usage.xml"/>    
   </resources>
+
+-->
   <resources>
     <description>Tasks</description>
 
-    <resource xml:id="_task-modifying-ignition-cloud" href="task-modifying-ignition-cloud.xml"/>
-    <resource xml:id="_task-slemicro-useradd" href="task-slemicro-useradd.xml"/>
+    <resource xml:id="_micro-cloud-ignition" href="../tasks/micro-cloud-ignition.xml"/>
+    <resource xml:id="_micro-cloud-useradd" href="../tasks/micro-cloud-useradd.xml"/>
   </resources>
   <!-- / R E S O U R C E S -->
   <!-- S T R U C T U R E -->
  <structure>
   <output renderas="article" xml:id="slema-public-cloud"/>
   <merge>
-     <title>&productnameshort; in Public Clouds</title>
+     <title>&productname; in Public Clouds</title>
      <revhistory>
        <title>Changelog</title>
        <revision>
          <revnumber>1</revnumber>
-         <date>2023-03-09</date>
+         <date>2023-03-29</date>
          <revdescription>
            <para>Initial version</para>
          </revdescription>
@@ -61,7 +65,7 @@
      <meta name="architecture" content="x86_64;zseries;power;aarch64"/>
      <!-- enter product name and version -->
      <meta name="productname">
-       <productname version="SLEMICRO">&slem;</productname>
+       <productname version="slemicro">&slem;</productname>
       </meta>
      <!-- SEO and social media -->
      <meta name="title">SLE Micro in Public Clouds</meta>
@@ -83,22 +87,37 @@
        <dm:editurl>https://github.com/SUSE/doc-modular/tree/main/articles/</dm:editurl>
        <dm:translation>no</dm:translation>
      </dm:docmanager>
-     <abstract>
-
-       <itemizedlist>
-         <title>Requirements</title>
-         <listitem><para>Basic understanding of public clouds.</para></listitem>
+     <abstract>       
+       <variablelist>
+        <varlistentry>
+            <term>TOPIC</term>
+            <listitem>
+              <para>
+                The article provides details about the &productnameshort; images intended for use in public clouds. On top of that, you will get information about creating new users of the system.
+              </para>
+            </listitem>
+          </varlistentry>
+         <varlistentry>
+            <term>REQUIREMENTS</term>
+            <listitem>
+            <itemizedlist>
+         <listitem>
+          <para>Basic understanding of public clouds.</para>
+        </listitem>
          <listitem>
            <para>
              &rootuser; or sudo privileges. 
            </para>
          </listitem>
-       </itemizedlist>
+         </itemizedlist>
+         </listitem>
+         </varlistentry>
+       </variablelist>
      </abstract>
    </merge>
-   <module renderas="section" resourceref="_concept-micro-cloud"/>
-  <module renderas="section" resourceref="_task-modifying-ignition-cloud"/>
-  <module renderas="section" resourceref="_task-slemicro-useradd"/>
+   <module renderas="section" resourceref="_micro-cloud"/>
+  <module renderas="section" resourceref="_micro-cloud-ignition"/>
+  <module renderas="section" resourceref="_micro-cloud-useradd"/>
   </structure>
 
 </assembly>
diff --git a/common/product-entities.ent b/common/product-entities.ent
@@ -2,9 +2,9 @@
 <!-- This file can be edited downstream. -->
 
 <!-- PRODUCT NAME AND VERSIONS -->
-<!ENTITY productname            "<phrase xmlns='http://docbook.org/ns/docbook'><phrase os='alp-micro'>&suse; ALP Micro</phrase><phrase os='alp-bedrock'>&suse; ALP Bedrock</phrase></phrase>">
-<!ENTITY productnameshort       "<phrase xmlns='http://docbook.org/ns/docbook'><phrase os='alp-micro'>ALP Micro</phrase><phrase os='alp-bedrock'>ALP Bedrock</phrase></phrase>">
-<!ENTITY productnumber          "<phrase xmlns='http://docbook.org/ns/docbook'>0.1</phrase>">
+<!ENTITY productname            "<phrase xmlns='http://docbook.org/ns/docbook'><phrase os='alp-micro'>&suse; ALP Micro</phrase><phrase os='alp-bedrock'>&suse; ALP Bedrock</phrase><phrase os='slemicro'>&slem;</phrase></phrase>">
+<!ENTITY productnameshort       "<phrase xmlns='http://docbook.org/ns/docbook'><phrase os='alp-micro'>ALP Micro</phrase><phrase os='alp-bedrock'>ALP Bedrock</phrase><phrase os='slemicro'>&slema;</phrase></phrase>">
+<!ENTITY productnumber          "<phrase xmlns='http://docbook.org/ns/docbook'><phrase os='slemicro'>5.4</phrase></phrase>">
 
 
 <!-- PROJECT REPOSITORY URL -->

diff --git a/xml/concept-micro-cloud.xml → concepts/micro-cloud.xml b/xml/concept-micro-cloud.xml → concepts/micro-cloud.xml
@@ -4,7 +4,7 @@
  title="Profiling step"?>
 <!DOCTYPE topic
 [
-  <!ENTITY % entities SYSTEM "generic-entities.ent">
+  <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
     %entities;
 ]>
 <topic xml:id="micro-public-clouds" xml:lang="en"
@@ -13,10 +13,14 @@
  xmlns:its="http://www.w3.org/2005/11/its"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xmlns:xlink="http://www.w3.org/1999/xlink">
-  <info>
-    <title>&productnameshort; public cloud images</title>
-    <meta name="maintainer" content="Jana Halackova"/>
-  </info>
+ <title>Basic information about the &productnameshort; public cloud images</title>
+          <info>
+      <abstract>
+        <para>
+          &productnameshort; uses several tools for its deployment in public clouds. This topic also describes required disk size, registration and provides details about the default user.
+        </para>
+      </abstract>
+    </info>
   <section xml:id="micro-cloud-introduction">
     <title>Introduction</title>
     <para>

diff --git a/xml/task-modifying-ignition-cloud.xml → tasks/micro-cloud-ignition.xml b/xml/task-modifying-ignition-cloud.xml → tasks/micro-cloud-ignition.xml
@@ -4,7 +4,7 @@
  title="Profiling step"?>
 <!DOCTYPE topic
 [
-  <!ENTITY % entities SYSTEM "generic-entities.ent">
+  <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
     %entities;
 ]>
 <topic xml:id="task-modifying-ignition-cloud"

diff --git a/xml/task-slemicro-useradd.xml → tasks/micro-cloud-useradd.xml b/xml/task-slemicro-useradd.xml → tasks/micro-cloud-useradd.xml
@@ -4,7 +4,7 @@
  title="Profiling step"?>
 <!DOCTYPE topic
 [
-  <!ENTITY % entities SYSTEM "generic-entities.ent">
+  <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
     %entities;
 ]>
 <topic xml:id="task-slemicro-useradd"