Skip to content

Commit

Permalink
xmlformat.
Browse files Browse the repository at this point in the history
  • Loading branch information
@lvicoun
lvicoun committed Mar 15, 2024
1 parent 24cba4e commit ccdbc7c
Show file tree
Hide file tree
Showing 5 changed files with 311 additions and 327 deletions.
127 changes: 51 additions & 76 deletions articles/Micro-upgrade.asm.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
-->
<!-- 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">
Expand All @@ -36,7 +35,6 @@
</resource>
</resources>
<!-- References -->

<!-- Legal -->
<resources>
<resource href="../common/legal.xml" xml:id="_legal">
Expand All @@ -49,35 +47,18 @@
<!-- 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>

<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-USE-ROOT-ID">
<revision><date>2054-11-14</date>
<revhistory xml:id="rh-upgrading-slemicro">
<revision><date>2024-03-14</date>
<revdescription>
<itemizedlist>
<!-- Group by type of change (added/removed/changed)-->
<listitem><para>Added sections:</para>
<itemizedlist>
<!-- Reference, but don't link to tracker items-->
<!-- Follow https://en.opensuse.org/openSUSE:Packaging_Patches_guidelines#Current_set_of_abbreviations for tracker item references-->
<listitem><para>New section on <quote>foo</quote> to resolve issue <uri>bsc#12345</uri></para></listitem>
<!-- Name sections, but don't insert links -->
<listitem><para>New section on <quote>foo bar</quote></para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Removed sections:</para>
<itemizedlist>
<listitem><para>Removed section on <quote>foo1</quote> to resolve issue <uri>bsc#12346</uri></para></listitem>
<listitem><para>Removed section on <quote>foo1 bar</quote></para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Changed sections:</para>
<itemizedlist>
<listitem><para>Changed section on <quote>foo2</quote> to resolve issue <uri>bsc#12347</uri></para></listitem>
<listitem><para>Changed section on <quote>foo2 bar</quote></para></listitem>
</itemizedlist>
<listitem>
<para>
Initial version
</para>
</listitem>
</itemizedlist>
</revdescription>
Expand All @@ -90,10 +71,10 @@
<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>
<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
Expand All @@ -105,85 +86,80 @@
<!-- 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>
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 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 name="category"><phrase>Upgrade</phrase>
</meta>
<!-- Determines "filter by task" filter value -->
<meta name="task">
<phrase>Upgrade</phrase>
</meta>
<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: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>
<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>
</varlistentry>
<varlistentry>
<term>GOAL</term>
<listitem>
<para>
A new running release of &productnameshort;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>REQUIREMENTS</term>
</varlistentry>
<varlistentry>
<term>REQUIREMENTS</term>
<listitem>
<itemizedlist>
<listitem>
<para>
A registered SLE Micro version 5.5
A registered SLE Micro version 5.5
</para>
</listitem>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
Expand All @@ -193,22 +169,21 @@ upgrade process, and potential rollback options.
<!-- 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>
<module resourceref="_Micro-upgrade-preparation" renderas="section"/>
<module resourceref="_Micro-upgrade-upgrading" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
<module resourceref="_legal"/>
<module resourceref="_gfdl">
<output renderas="appendix"/>
Expand Down
76 changes: 40 additions & 36 deletions concepts/Micro-upgrade-about.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,57 +18,61 @@
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 -->
<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 -->
<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>
&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>
&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
&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>
</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>
<para>
Canceling is possible until you reboot your system.
</para>
</listitem>
<listitem>
<para>
Simple recovery if there is an error.
</para>
<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>
<para>
Possible <quote>rollback</quote> via system tools&mdash;no backup or
restore needed.
</para>
</listitem>
<listitem>
<para>
Use of all active repositories.
</para>
<para>
Use of all active repositories.
</para>
</listitem>
</itemizedlist>
</itemizedlist>
</topic>
8 changes: 5 additions & 3 deletions snippets/Micro-upgrade-path.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
<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>
<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>
Loading

0 comments on commit ccdbc7c

Please sign in to comment.