Draft content

DC-SLE-agama-installation-x86-64

@@ -1,17 +1,17 @@
 # This file originates from the project https://github.com/openSUSE/doc-kit
 # This file can be edited downstream.
 
-MAIN="assembly.asm.xml"
+MAIN="sle-agama-installation-x86-64.asm.xml"
 # Point to the ID of the <structure> of your assembly
-ROOTID="article-example"
+ROOTID="sle-agama-installation-x86-64"
 SRC_DIR="articles"
 IMG_SRC_DIR="images"
 
 ## Profiling
-PROFOS="PRODUCT"
-#PROFCONDITION="PRODUCTNUMBER"
+PROFOS="sles;sles4sapa"
+PROFCONDITION="sles;sles4sapa"
 #STRUCTID="STRUCTURE-ID"
-#PROFARCH="x86_64;zseries;power;aarch64"
+PROFARCH="x86-64"
 
 DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat"
 

articles/sle-agama-installation-x86-64.asm.xml

@@ -20,34 +20,34 @@
   <!-- R E S O U R C E S -->
   <!-- Glue files -->
   <resources>
-    <resource xml:id="_glue-example" href="../glues/glue.xml">
+    <!-- resource xml:id="_glue-example" href="../glues/glue.xml">
       <description>Glue example</description>
+      </resource-->
+    <resource xml:id="_sle-agama-installation-x86-64-more-info" href="../glues/sle-agama-installation-x86-64-more-info.xml">
+      <description>More information on &sles; and &sles4sapa; installation</description>
     </resource>
-    <resource xml:id="_glue-more-info" href="../glues/glue-more-info.xml">
-      <description>Glue for more information</description>
-    </resource>
-    <resource xml:id="_glue-whats-next" href="../glues/glue-whats-next.xml">
+    <!-- resource xml:id="_glue-whats-next" href="../glues/glue-whats-next.xml">
       <description>Glue what's next</description>
-    </resource>
+      </resource-->
   </resources>
   <!-- Concept files -->
-  <resources>
+  <!-- resources>
     <resource xml:id="_concept-example" href="../concepts/concept.xml">
-      <description>Concept example</description>
+    <description>Concept example</description>
     </resource>
-  </resources>
+    </resources-->
   <!-- Tasks -->
   <resources>
-    <resource xml:id="_task-example" href="../tasks/task.xml">
-      <description>Task example</description>
+    <resource xml:id="_sle-agama-manual-installation-x86-64" href="../tasks/sle-agama-manual-installation-x86-64.xml">
+      <description>Manual installation of &sles; or &sles4sapa; using &agama; on &x86-64; machines</description>
     </resource>
   </resources>
   <!-- References -->
-  <resources>
+  <!-- resources>
     <resource xml:id="_reference-example" href="../references/reference.xml">
-      <description>Reference example</description>
+    <description>Reference example</description>
     </resource>
-  </resources>
+    </resources-->
   <!-- Legal -->
   <resources>
     <resource href="../common/legal.xml" xml:id="_legal">
@@ -58,24 +58,16 @@
     </resource>
   </resources>
   <!-- S T R U C T U R E -->
-  <structure renderas="article" xml:id="article-example" xml:lang="en">
+  <structure renderas="article" xml:id="sle-agama-installation-x86-64" xml:lang="en">
     <merge>
-      <title>Your title (title style), limit to 55 chars, if possible</title>
-      <subtitle>Subtitle if necessary</subtitle>
+      <title>Installing &sle; using &agama;</title>
+      <!-- subtitle>Manual procedure for &sles; or &sles4sapa; on &x86-64; machines</subtitle-->
       <!-- Create revision history to enable versioning: adjust the placeholder revhistory ID,
-           for each entry add the date of when the updated article will be published,
-           list most recent date/entry at the top -->
+        for each entry add the date of when the updated article will be published,
+        list most recent date/entry at the top -->
       <!-- Check https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-revhistory for detailed instructions-->
-      <revhistory xml:id="rh-USE-ROOT-ID">
-        <revision><date>YYYY-MM-DD</date>
-          <revdescription>
-            <!-- briefly sum up the major changes for the reader-->
-            <para>
-              Updated CONTENT, extended CONTENT, removed CONTENT
-            </para>
-          </revdescription>
-        </revision>
-        <revision><date>YYYY-MM-DD</date>
+      <revhistory xml:id="rh-sle-agama-installation-x86-64">
+        <revision><date>2024-01-28</date>
           <revdescription>
             <para>
               Updated for the initial release of &productname; &productnumber;
@@ -85,85 +77,105 @@
       </revhistory>
       <!-- TODO: provide a listing of possible and validatable meta entry values. Maybe in our geekodoc repo? -->
       <!-- add author's e-mail -->
-      <meta name="maintainer" content="" its:translate="no"/>
-      <meta name="architecture">
-        <phrase>&x86-64;</phrase>
-        <phrase>&power;</phrase>
+      <meta name="[email protected]" content="" its:translate="no"/>
+      <meta name="architecture"><phrase>&intel64;</phrase><phrase>&arm64;</phrase>
       </meta>
       <!-- enter one or more product names and version -->
-      <meta name="productname" its:translate="no">
-        <productname version="X.Y">&productname;</productname>
+      <meta name="productname" its:translate="no"><productname version="16.0">&productname;</productname>
       </meta>
-      <meta name="title" its:translate="yes">title for SEO and social media, max. 55 chars, keep in sync with article title</meta>
-      <meta name="description" its:translate="yes">short description, max. 150 chars, no full stop: How to perform task xyz </meta>
-      <meta name="social-descr" its:translate="yes">ultrashort description for social media, max. 55 chars, no full stop: Perform task xyz</meta>
+      <meta name="title" its:translate="yes">Installing &sles; using &agama;</meta>
+      <meta name="description" its:translate="yes">How to install &sles; or &sles4sapa; using &agama; on &x86-64; machines</meta>
+      <meta name="social-descr" its:translate="yes">Installing &sles; using &agama;</meta>
       <!-- suitable categories has to be identical with the category selected in the docserv config -->
-      <meta name="category" its:translate="no">
-        <phrase>Systems Management</phrase>
+      <meta name="category" its:translate="no"><phrase>Systems Management</phrase>
       </meta>
       <!-- Determines "filter by task" filter value -->
       <!-- either add link to list or list of tasks-->
-      <meta name="task" its:translate="no">
-        <phrase>Configuration</phrase>
-        <phrase>Installation</phrase>
+      <meta name="task" its:translate="no"><phrase>Installation</phrase>
       </meta>
       <meta name="series">Products &amp; Solutions</meta>
       <dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
         <dm:bugtracker>
           <dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
           <dm:component>Documentation</dm:component>
-          <dm:product><!--Bugzilla product string--></dm:product>
+          <dm:product>
+            <!--Bugzilla product string-->
+          </dm:product>
           <!--
-          if the assembly applies to multiple products/productversions, use profiling:
-          <dm:product os="sles" condition="16.0">SUSE Linux Enterprise Server 16.0</dm:product>
-          <dm:product os="sles" condition="16.1">SUSE Linux Enterprise Server 16.1</dm:product>
-          -->
-          <dm:assignee>MAINTAINER@suse.com</dm:assignee>
+            if the assembly applies to multiple products/productversions, use profiling:
+            <dm:product os="sles" condition="16.0">SUSE Linux Enterprise Server 16.0</dm:product>
+            <dm:product os="sles" condition="16.1">SUSE Linux Enterprise Server 16.1</dm:product>
+            -->
+          <dm:assignee>souvik.sarkar@suse.com</dm:assignee>
           <!-- replace with your BUGZILLA e-mail address, otherwise this does not work-->
-       </dm:bugtracker>
+        </dm:bugtracker>
         <dm:translation>yes</dm:translation>
       </dm:docmanager>
       <abstract>
-      <variablelist>
-        <varlistentry>
-          <term>WHAT?</term>
-          <listitem>
-            <para>
-              Describe your topic in one sentence.
-            </para>
-          </listitem>
-        </varlistentry>
-        <varlistentry>
-          <term>WHY?</term>
-          <listitem>
-            <para>
-              State the reason why one should read this.
-            </para>
-          </listitem>
-        </varlistentry>
-        <varlistentry>
-          <term>EFFORT</term>
+        <variablelist>
+          <varlistentry>
+            <term>WHAT?</term>
+            <listitem>
+              <para>
+                This article describes how to install &sles; or &sles4sapa; using &agama; on
+                &x86-64; machines.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>WHY?</term>
             <listitem>
               <para>
-                What's the effort one has to put in?
+                Read this article to understand the process of installing &sles; or &sles4sapa;
+                using &agama; on &x86-64; machines.
               </para>
             </listitem>
-        </varlistentry>
-        <varlistentry>
-          <term>GOAL</term>
+          </varlistentry>
+          <varlistentry>
+            <term>EFFORT</term>
             <listitem>
               <para>
-                What's the reader's take-away from this article?
+                You may need 15 minutes to read this article.
               </para>
             </listitem>
-        </varlistentry>
-        <varlistentry>
-          <term>REQUIREMENTS</term>
+          </varlistentry>
+          <varlistentry>
+            <term>GOAL</term>
+            <listitem>
+              <para>
+                Understand how to install &sles; or &sles4sapa; using &agama; on &x86-64; machines.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>REQUIREMENTS</term>
             <listitem>
               <itemizedlist>
                 <listitem>
                   <para>
-                    List the requirements to accomplish the task(s) described below.
+                    An &x86-64; system &ndash; either bare metal or a virtual machine with a
+                    minimum of 1&nbsp;CPU, 2&nbsp;GB memory and 16&nbsp;GB storage.
+                  </para>
+                </listitem>
+                <listitem>
+                  <para>
+                    An &agama;&dash;based ISO image file for supported versions of &sles; or
+                    &sles4sapa;. You can download it from the &scc; and verify its checksum to
+                    ensure its integrity.
+                  </para>
+                  <note>
+                    <title>Supported &sle; version</title>
+                    <para>
+                      Currently, the &agama;&dash;based installation images are available only for
+                      &sles; 16.0 and &sles4sapa; 16.0.
+                    </para>
+                  </note>
+                </listitem>
+                <listitem>
+                  <para>
+                    An active registration code for the product you want to install. You can
+                    generate a registration code for the product and activate its subscription for
+                    your organization at the &scc;.
                   </para>
                 </listitem>
               </itemizedlist>
@@ -175,17 +187,17 @@
     <!-- pull in all the topic files you need -->
     <!-- pick the appropriate type of include to match your needs -->
     <!-- pull in a topic as is -->
-    <module resourceref="_glue-example" renderas="section"/>
+    <!-- module resourceref="_glue-example" renderas="section"/-->
     <!-- pull in a topic and switch the title -->
-    <module resourceref="_concept-example" renderas="section">
+    <!-- module resourceref="_concept-example" renderas="section">
       <merge>
-        <title>You are a very special concept now!</title>
+      <title>You are a very special concept now!</title>
       </merge>
-    </module>
-    <module resourceref="_task-example" renderas="section"/>
-    <module resourceref="_reference-example" renderas="section"/>
-    <module resourceref="_glue-more-info" renderas="section"/>
-    <module resourceref="_glue-whats-next" renderas="section"/>
+      </module-->
+    <module resourceref="_sle-agama-manual-installation-x86-64" renderas="section"/>
+    <!-- module resourceref="_reference-example" renderas="section"/-->
+    <module resourceref="_sle-agama-installation-x86-64-more-info" renderas="section"/>
+    <!--module resourceref="_glue-whats-next" renderas="section"/-->
     <module resourceref="_legal"/>
     <module resourceref="_gfdl">
       <output renderas="appendix"/>

common/product-entities.ent

@@ -5,9 +5,9 @@
 
 <!-- Use "&generic;" for everything not ALP and SLE Micro -->
 
-<!ENTITY productname            "<phrase xmlns='http://docbook.org/ns/docbook'><phrase os='suseai'>&suseai;</phrase><phrase os='alp-dolomite'>ALP Dolomite</phrase><phrase os='slmicro'>&slm;</phrase><phrase os='slemicro'>&slem;</phrase><phrase os='sles'>&sles;</phrase></phrase>">
-<!ENTITY productnameshort       "<phrase xmlns='http://docbook.org/ns/docbook'><phrase os='suseai'>&suseaia;</phrase><phrase os='alp-dolomite'>Dolomite</phrase><phrase os='slmicro'>&slm;</phrase><phrase os='slemicro'>&slema;</phrase><phrase os='sles'>&slsa;</phrase></phrase>">
-<!ENTITY productnumber          "<phrase xmlns='http://docbook.org/ns/docbook'><phrase os='suseai'>1.0</phrase><phrase os='alp-dolomite'>1.0</phrase><phrase os='slemicro_5.4'>5.4</phrase><phrase os='slmicro_5.5'>5.5</phrase><phrase os='slmicro'>6.1</phrase><phrase os='sles'>16.0</phrase></phrase>">
+<!ENTITY productname            "<phrase xmlns='http://docbook.org/ns/docbook'><phrase os='suseai'>&suseai;</phrase><phrase os='alp-dolomite'>ALP Dolomite</phrase><phrase os='slmicro'>&slm;</phrase><phrase os='slemicro'>&slem;</phrase><phrase os='sles'>&sles;</phrase><phrase os='sles4sapa'>&sles4sapa;</phrase></phrase>">
+<!ENTITY productnameshort       "<phrase xmlns='http://docbook.org/ns/docbook'><phrase os='suseai'>&suseaia;</phrase><phrase os='alp-dolomite'>Dolomite</phrase><phrase os='slmicro'>&slm;</phrase><phrase os='slemicro'>&slema;</phrase><phrase os='sles'>&slsa;</phrase><phrase os='sles4sapa'>&sles4sapa;</phrase></phrase>">
+<!ENTITY productnumber          "<phrase xmlns='http://docbook.org/ns/docbook'><phrase os='suseai'>1.0</phrase><phrase os='alp-dolomite'>1.0</phrase><phrase os='slemicro_5.4'>5.4</phrase><phrase os='slmicro_5.5'>5.5</phrase><phrase os='slmicro'>6.1</phrase><phrase os='sles'>16.0</phrase><phrase os='sles4sapa'>16.0</phrase></phrase>">
 
 <!-- PROJECT REPOSITORY URL -->
 <!ENTITY repo-url               "https://github.com/SUSE/doc-modular">
@@ -23,4 +23,4 @@
 <!-- START YEAR OF COPYRIGHT -->
 <!ENTITY copyrightstart         "2023">
 <!-- COPYRIGHT HOLDER(S) -->
-<!ENTITY copyrightholder        "SUSE LLC">
+<!ENTITY copyrightholder        "SUSE LLC">

glues/sle-agama-installation-x86-64-more-info.xml

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
+<!-- This file can be edited downstream. -->
+<!DOCTYPE topic
+[
+  <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+    %entities;
+]>
+<topic xml:id="sle-agama-installation-x86-64-more-info"
+ role="glue" xml:lang="en"
+ xmlns="http://docbook.org/ns/docbook" version="5.2"
+ 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"
+ xmlns:trans="http://docbook.org/ns/transclusion">
+  <info>
+    <title>For more information</title>
+    <!-- can be changed via merge in the
+      assembly -->
+    <!--add author's e-mail address-->
+    <meta name="[email protected]" content="" its:translate="no"/>
+    <!-- add an abstract/para here, if you need one -->
+    <!-- can be changed via merge in the assembly -->
+  </info>
+  <para>
+    For information on related topics, refer to the following resources:
+  </para>
+  <itemizedlist>
+    <listitem>
+      <para>
+        Detailed information on the open-source &agama; project is available on its website:
+        <link xlink:href="https://agama-project.github.io"></link>.
+      </para>
+    </listitem>
+    <listitem>
+      <para>
+        Installation Quick Start for &sles; 15 SP6 using the conventional installer is available at
+        <link xlink:href="https://documentation.suse.com/sles/15-SP6/html/SLES-all/article-installation.html"></link>.
+      </para>
+    </listitem>
+    <listitem>
+      <para>
+        Deployment Guide containing detailed information on conventional methods of installing and
+        deploying &sles; 15 SP6 on &arm64; and &intel64; machines is available at
+        <link xlink:href="https://documentation.suse.com/sles/15-SP6/html/SLES-all/cha-x86.html"></link>.
+      </para>
+    </listitem>
+    <listitem>
+      <para>
+        Installation Quick Start for &sles4sapa; 15 SP6 using the conventional installer is
+        available at
+        <link xlink:href="https://documentation.suse.com/sles-sap/15-SP6/html/SLES-SAP-installation/index.html"></link>.
+      </para>
+    </listitem>
+  </itemizedlist>
+</topic>