Merge pull request #308 from SUSE/jhalackova_upgrade

Jhalackova upgrade

DC-Micro-upgrade

@@ -0,0 +1,15 @@
+## ---------------------------- 
+## Doc Config File for the DB Assembly 
+## ----------------------------
+##
+## Basics
+MAIN="Micro-upgrade.asm.xml"
+SRC_DIR="articles"
+
+## Profiling
+PROFOS="slemicro"
+#PROFARCH="x86_64;zseries;power;aarch64"
+
+## stylesheet location
+STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
+FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2021-ns"

articles/Micro-upgrade.asm.xml

@@ -0,0 +1,192 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
+<!-- This file can be edited downstream. -->
+<!DOCTYPE assembly
+[
+    <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+    %entities;
+]>
+<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
+<!-- point back to this document with a similar comment added to your legacy doc piece -->
+<!-- refer to README.md for file and id naming conventions -->
+<assembly version="5.2" xml:lang="en"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:trans="http://docbook.org/ns/transclusion"
+          xmlns:its="http://www.w3.org/2005/11/its"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns="http://docbook.org/ns/docbook">
+  <!-- resources section references all topic chunks used in the final article
+    -->
+  <!-- R E S O U R C E S -->
+  <!-- Glue files -->
+  <!-- Concept files -->
+  <resources>
+    <resource xml:id="_Micro-upgrade-about" href="../concepts/Micro-upgrade-about.xml">
+      <description>Introduction</description>
+    </resource>
+  </resources>
+  <!-- Tasks -->
+  <resources>
+    <resource xml:id="_Micro-upgrade-preparation" href="../tasks/Micro-upgrade-preparation.xml">
+      <description>Preparing the machine</description>
+    </resource>
+    <resource xml:id="_Micro-upgrade-upgrading" href="../tasks/Micro-upgrade-upgrading.xml">
+      <description>Upgrading the machine</description>
+    </resource>
+  </resources>
+  <!-- References -->
+  <!-- Legal -->
+  <resources>
+    <resource href="../common/legal.xml" xml:id="_legal">
+      <description>Legal Notice</description>
+    </resource>
+    <resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl">
+      <description>GNU Free Documentation License</description>
+    </resource>
+  </resources>
+  <!-- S T R U C T U R E -->
+  <structure renderas="article" xml:id="upgrading-slemicro" xml:lang="en">
+    <merge>
+      <title>Upgrading &productnameshort; from Previous Releases</title>
+      <!-- Create revision history to enable versioning; add most recent entries at the top. -->
+      <!-- Check https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-revhistory for detailed instructions-->
+      <revhistory xml:id="rh-upgrading-slemicro">
+        <revision><date>2024-03-14</date>
+          <revdescription>
+            <itemizedlist>
+              <!-- Group by type of change (added/removed/changed)-->
+              <listitem>
+                <para>
+                  Initial version
+                </para>
+              </listitem>
+            </itemizedlist>
+          </revdescription>
+        </revision>
+      </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="[email protected]" its:translate="no"/>
+      <!-- ISO date of last update as YYYY-MM-DD -->
+      <meta name="updated" content="2024-03-13" its:translate="no"/>
+      <!-- this does not work yet. Use the dm tags listed below for now
+        <meta name="bugtracker" its:translate="no">
+        <phrase role="url">https://bugzilla.suse.com/enter_bug.cgi</phrase>
+        <phrase role="component">Non-product-specific documentation</phrase>
+        <phrase role="product">Smart Docs</phrase>
+        <phrase role="assignee">[email protected]</phrase>
+        </meta>
+        -->
+      <!-- not supported, yet. Use dm: tag for now
+        <meta name="translation" its:translate="no">
+        <phrase role="trans">yes</phrase>
+        <phrase role="language">de-de,cs-cz</phrase>
+        </meta>
+        -->
+      <!-- enter the platform identifier or a list of
+        identifiers, separated by ; -->
+      <!-- For a full list of meta tags and their values,
+        see https://confluence.suse.com/x/aQDWNg
+        -->
+      <meta name="architecture"><phrase>&x86-64;</phrase><phrase>&aarch64;</phrase><phrase>&ibm;</phrase>
+      </meta>
+      <!-- enter one or more product names and version -->
+      <meta name="productname" its:translate="no"><productname version="6.0">&productname;</productname>
+      </meta>
+      <meta name="title" its:translate="yes">Upgrade procedure for &productnameshort;</meta>
+      <meta name="description" its:translate="yes">Upgrading from &productnameshort; 5.X releases
+      to &productnameshort; 6.X releases</meta>
+      <meta name="social-descr" its:translate="yes">Upgrade procedure for &productnameshort;</meta>
+      <!-- suitable categories -->
+      <meta name="category"><phrase>Upgrade</phrase>
+      </meta>
+      <!-- Determines "filter by task" filter value -->
+      <meta name="task"><phrase>Upgrade</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>Smart Docs</dm:component>
+          <dm:product>Documentation</dm:product>
+          <!-- provide your BUGZILLA e-mail address, otherwise this does not work correctly-->
+          <dm:assignee>[email protected]</dm:assignee>
+        </dm:bugtracker>
+        <dm:translation>yes</dm:translation>
+      </dm:docmanager>
+      <abstract>
+        <variablelist>
+          <varlistentry>
+            <term>WHAT?</term>
+            <listitem>
+              <para>
+                This document offers a comprehensive guide to upgrading
+                &productnameshort; from version 5.5 to version 6.0, detailing
+                the preparatory steps, upgrade process, and potential rollback
+                options.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>WHY?</term>
+            <listitem>
+              <para>
+                You want to have the new release of &productnameshort;.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>EFFORT</term>
+            <listitem>
+              <para>
+                It takes approximately 20 minutes to read the article.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>GOAL</term>
+            <listitem>
+              <para>
+                A new running release of &productnameshort;.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>REQUIREMENTS</term>
+            <listitem>
+              <itemizedlist>
+                <listitem>
+                  <para>
+                    A registered SLE Micro version 5.5
+                  </para>
+                </listitem>
+              </itemizedlist>
+            </listitem>
+          </varlistentry>
+        </variablelist>
+      </abstract>
+    </merge>
+    <!-- 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="_Micro-upgrade-about" renderas="section">
+      <merge>
+        <abstract>
+          <para/>
+        </abstract>
+      </merge>
+    </module>
+    <module resourceref="_Micro-upgrade-preparation" renderas="section"/>
+    <module resourceref="_Micro-upgrade-upgrading" renderas="section">
+      <merge>
+        <abstract>
+          <para/>
+        </abstract>
+      </merge>
+    </module>
+    <module resourceref="_legal"/>
+    <module resourceref="_gfdl">
+      <output renderas="appendix"/>
+    </module>
+  </structure>
+</assembly>

concepts/Micro-upgrade-about.xml

@@ -0,0 +1,78 @@
+<?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;
+]>
+<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
+<!-- point back to this document with a similar comment added to your legacy doc piece -->
+<!-- refer to README.md for file and id naming conventions -->
+<!-- metadata is dealt with on the assembly level -->
+<topic xml:id="upgrading-micro-about"
+ role="concept" 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>Introduction to the upgrade procedure</title>
+    <!-- can be changed via merge in the assembly -->
+    <!--add author's email address-->
+    <meta name="maintainer" content="" its:translate="no"/>
+    <abstract>
+      <!-- can be changed via merge in the assembly -->
+      <para>
+        &productnameshort; allows upgrading from an existing system to the new
+        version. No new installation is needed. Existing data, such as home and
+        data directories and system configuration, is kept intact.
+      </para>
+    </abstract>
+  </info>
+  <!--<xi:include href="../snippets/SLE-Micro-upgrade-path.xml"/> -->
+  <para>
+    &suse; supports upgrades between two releases of &productname;. Whether it
+    is better to upgrade or perform a fresh installation depends on your
+    specific scenario. While upgrades involve less work, fresh installations
+    ensure you benefit from all the new features of a release, such as disk
+    layout changes, specific filesystem features, and other improvements. To
+    get the most out of your system, &suse; therefore recommends fresh
+    installations in most scenarios.
+  </para>
+  <para>
+    &suse; releases a new version of &productnameshort; twice a year and the
+    product comes with 4 years of general support (for details regarding
+    &productnameshort; lifecycle, refer to
+    <link
+    xlink:href="https://www.suse.com/lifecycle"/>).
+  </para>
+  <para>
+    &productnameshort; uses <emphasis>transactional updates</emphasis> to
+    upgrade from one version to the next. This has the following advantages:
+  </para>
+  <itemizedlist>
+    <listitem>
+      <para>
+        Canceling is possible until you reboot your system.
+      </para>
+    </listitem>
+    <listitem>
+      <para>
+        Simple recovery if there is an error.
+      </para>
+    </listitem>
+    <listitem>
+      <para>
+        Possible <quote>rollback</quote> via system tools&mdash;no backup or
+        restore needed.
+      </para>
+    </listitem>
+    <listitem>
+      <para>
+        Use of all active repositories.
+      </para>
+    </listitem>
+  </itemizedlist>
+</topic>

snippets/Micro-upgrade-path.xml

@@ -0,0 +1,13 @@
+<!DOCTYPE important [
+  <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+  %entities;
+]>
+<important  xmlns="http://docbook.org/ns/docbook"  version="5.2"
+xmlns:xi="http://www.w3.org/2001/XInclude" 
+xmlns:xlink="http://www.w3.org/1999/xlink">
+  <title>Upgrade is possible only from the 5.5 release</title>
+  <para>
+    If you are upgrading from other 5.X release than 5.5, you need to at first
+    migrate to 5.5 before you trigger the upgrade to 6.0.
+  </para>
+</important>