updates in ketadata

.gitignore

@@ -8,3 +8,5 @@
 build/
 .vscode/
 .idea/
+*.code-workspace
+.vimrc

doc-kit.conf

@@ -1,11 +1,12 @@
 type: docbook5-book
 variant: license-cc
 
-file: dc865ed00674536288a1e5a78ba07fe138aaabde  .gitignore
+file: d5aba8356449342d0bac0a62116b85f1b44ee73d  .gitignore
 file: c6b4745307e90c9b88905b434cbbaddc54e4541b  .editorconfig
-file: 71184e815d1926f8489fa2c2eefbe15395805b10  xml/generic-entities.ent
+file: 86faacc738c3e74d637e7c19618ebd2a1e41291d  xml/generic-entities.ent
 file: a79a3bc929478668955564bab48aecc8502555f6  xml/network-entities.ent
-file: 6f13c1c605e11c3499f9d18335e2bdadf6a0c73d  xml/common_intro_support.xml
-file: 678db25fa5a1f62232af7eb8db24fe409b4a11d5  xml/common_intro_convention.xml
-file: bf554272c25b6899d057daab2ebd88eecde6477f  xml/common_intro_feedback.xml
-file: daf531111e37c41662988c631f87a734c3f55201  xml/common_copyright_cc.xml
+file: 42fafc60a5e9622a138cede94d63a5b0bdc118c1  xml/common_intro_available_doc.xml
+file: ee8dbf17324e3e72b54bcb6fcc5dec7f7e4e1e9b  xml/common_intro_support.xml
+file: 0e30d909a3d9305a496f3aecf3aa981f3f16f465  xml/common_intro_convention.xml
+file: 2af06d76aa36c3a85968e56e24440d56926cf81b  xml/common_intro_feedback.xml
+file: 9a639e04d111e34e9bd14693b1c2bf84572be613  xml/common_copyright_cc.xml

xml/book_storage_admin.xml

@@ -23,6 +23,9 @@
   <meta name="task" its:translate="no">
     <phrase>Administration</phrase>
   </meta>
+  <meta name="description" its:translate="yes">
+    This guide focuses on routine tasks that you as an administrator need to take care of after the basic Ceph cluster has been deployed.
+  </meta>
   <meta name="series" its:translate="no">Product Documentation</meta>
  </info>
  <xi:include href="preface_admin.xml" parse="xml"/>

xml/book_storage_deployment.xml

@@ -25,6 +25,8 @@
   <meta name="task" its:translate="no">
     <phrase>Deployment</phrase>
   </meta>
+  <meta name="description" its:translate="yes">
+    This guide focuses on deploying a basic Ceph cluster, and how to deploy additional services.</meta>
   <meta name="series" its:translate="no">Product Documentation</meta>
  </info>
  <xi:include href="preface_deployment.xml" parse="xml"/>

xml/book_storage_rook.xml

@@ -25,6 +25,9 @@
     <phrase>Administration</phrase>
     <phrase>Deployment</phrase>
   </meta>
+  <meta name="description" its:translate="no">
+    <phrase>This guide focuses on deploying containerized Ceph clusters on SUSE CaaS Platform.</phrase>
+  </meta>
   <meta name="series" its:translate="no">Product Documentation</meta>
   <abstract>
    <para>

xml/book_storage_security.xml

@@ -24,6 +24,9 @@
   <meta name="task" its:translate="no">
      <phrase>Security</phrase>
   </meta>
+  <meta name="description" its:translate="no">
+    <phrase>This guide focuses on how to ensure that your Ceph cluster is secure.</phrase>
+ </meta>
   <meta name="series" its:translate="no">Product Documentation</meta>
  </info>
  <xi:include href="preface_security.xml" parse="xml"/>

xml/book_storage_troubleshooting.xml

@@ -21,10 +21,12 @@
   </dm:docmanager>
   <xi:include href="common_copyright_cc.xml"/>
   <xi:include href="authors.xml"/>
-  <!--<meta name="task" its:translate="no">
-   <phrase>Administration</phrase>
-   <phrase>Deployment</phrase>
-  </meta>-->
+  <meta name="task" its:translate="no">
+   <phrase>Troubleshooting</phrase>
+  </meta>
+  <meta name="description" its:translate="no">
+    <phrase>This guide takes you through various common problems when running SUSE Enterprise Storage 7.1 and other related issues to relevant components such as Ceph or Object Gateway.</phrase>
+   </meta>
   <meta name="series" its:translate="no">Product Documentation</meta>
  </info>
  <xi:include href="preface_troubleshooting.xml" parse="xml"/>

xml/book_storage_windows.xml

@@ -21,10 +21,14 @@
   </dm:docmanager>
   <xi:include href="common_copyright_cc.xml"/>
   <xi:include href="authors-windows.xml"/>
-  <!--<meta name="task" its:translate="no">
-   <phrase>Administration</phrase>
-   <phrase>Deployment</phrase>
-  </meta>-->
+  <meta name="task" its:translate="no">
+   <phrase>Installation</phrase>
+   <phrase>Integration</phrase>
+   <phrase>Configuration</phrase>
+  </meta>
+  <meta name="description" its:translate="no">
+    <phrase>This guide describes the integration, installation and configuration of Microsoft Windows environments and SUSE Enterprise Storage using the Windows Driver.</phrase>
+   </meta>
   <meta name="series" its:translate="no">Product Documentation</meta>
  </info>
  <xi:include href="preface_windows.xml" parse="xml"/>

xml/common_copyright_cc.xml

@@ -30,7 +30,7 @@
  </para>
  <para>
   For &suse; trademarks, see
-  <link xlink:href="http://www.suse.com/company/legal/"/>. All
+  <link xlink:href="https://www.suse.com/company/legal/"/>. All
   third-party trademarks are the property of their respective owners. Trademark
   symbols (&reg;, &trade; etc.) denote trademarks of &suse; and its affiliates.
   Asterisks (&thrdmrk;) denote third-party trademarks.

xml/common_intro_available_doc.xml

@@ -1,6 +1,7 @@
 <?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. -->
+<!-- This file is part of the project https://github.com/openSUSE/doc-kit -->
+<!-- DO NOT EDIT THIS FILE DOWNSTREAM. IT MAY BE OVERWRITTEN BY AN UPDATE. -->
+
 <?xml-stylesheet href="urn:x-suse:xslt:profiling:docbook51-profile.xsl"
  type="text/xml"
  title="Profiling step"?>
@@ -18,89 +19,64 @@
  <info>
   <dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
    <dm:translation>yes</dm:translation>
-   <dm:release>SES 7</dm:release>
   </dm:docmanager>
  </info>
 
- <note>
-  <title>Online documentation and latest updates</title>
-  <para>
-   Documentation for our products is available at
-   <link os="sles;sled" xlink:href="&dsc;"/><link os="osuse"
-   xlink:href="http://doc.opensuse.org/"/>,
-   where you can also find the latest updates, and browse or download the
-   documentation in various formats. The latest documentation updates can be
-   found in the English language version.
-  </para>
- </note>
-
- <para>
-  In addition, the product documentation is available in your installed system
-  under <filename>/usr/share/doc/manual</filename>. It is included in an RPM
-  package named
-  <package>ses-manual_<replaceable>LANG_CODE</replaceable></package>. Install
-  it if it is not already on your system, for example:
- </para>
-
-<screen>&prompt.root;zypper install ses-manual_en</screen>
-
- <para>
-  The following documentation is available for this product:
- </para>
-
  <variablelist>
   <varlistentry>
-   <term><link xlink:href="https://documentation.suse.com/ses/html/ses-all/book-storage-deployment.html"
-    ><citetitle>Deployment Guide</citetitle></link></term>
+   <term>Online documentation</term>
    <listitem>
     <para>
-     This guide focuses on deploying a basic &ceph; cluster, and how to deploy
-     additional services. It also cover the steps for upgrading to
-     &productname; &productnumber; from the previous product version.
+     Our documentation is available online at <link condition="suse-product"
+      xlink:href="&dsc;"/><link condition="community-project"
+      xlink:href="&doo;"/>.
+     Browse or download the documentation in various formats.
     </para>
+    <note>
+     <title>Latest updates</title>
+     <para>
+      The latest updates are usually available in the English-language version of this documentation.
+     </para>
+    </note>
    </listitem>
   </varlistentry>
   <varlistentry>
-   <term><link xlink:href="https://documentation.suse.com/ses/html/ses-all/book-storage-admin.html"
-    ><citetitle>Administration and Operations Guide</citetitle></link></term>
+   <term>&suse; Knowledgebase</term>
+   <!--based on 'Support Resources' listed at https://www.suse.com/support/kb/-->
    <listitem>
     <para>
-     This guide focuses on routine tasks that you as an administrator need to
-     take care of after the basic &ceph; cluster has been deployed (day 2
-     operations). It also describes all the supported ways to access data
-     stored in a &ceph; cluster.
-    </para>
+     If you run into an issue, 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>
-   <term><link xlink:href="https://documentation.suse.com/ses/html/ses-all/book-storage-security.html"
-    ><citetitle>Security Hardening Guide</citetitle></link></term>
+  <varlistentry condition="suse-product">
+   <term>Release notes</term>
    <listitem>
     <para>
-     This guide focuses on how to ensure your cluster is secure.
+     For release notes, see
+     <link xlink:href="https://www.suse.com/releasenotes/"/>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
-   <term><link xlink:href="https://documentation.suse.com/ses/html/ses-all/book-storage-troubleshooting.html"
-    ><citetitle>Troubleshooting Guide</citetitle></link></term>
+   <term>In your system</term>
    <listitem>
     <para>
-     This guide takes you through various common problems when running
-     &productname; &productnumber; and other related issues to relevant
-     components such as &ceph; or &ogw;.
+      For offline use, the release notes are also available under
+      <filename>/usr/share/doc/release-notes</filename> on your system.
+      The documentation for individual packages is available at
+      <filename>/usr/share/doc/packages</filename>.
     </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term><link xlink:href="https://documentation.suse.com/ses/html/ses-all/book-storage-windows.html"
-    ><citetitle>&productname; for Windows Guide</citetitle></link></term>
-   <listitem>
     <para>
-     This guide describes the integration, installation, and configuration of
-     Microsoft Windows environments and &productname; using the Windows Driver.
+      Many commands are also described in their <emphasis>manual
+      pages</emphasis>. To view them, run <command>man</command>, followed
+      by a specific command name. If the <command>man</command> command is
+      not installed on your system, install it with <command>sudo zypper
+      install man</command>.
     </para>
-   </listitem>
+  </listitem>
   </varlistentry>
  </variablelist>
-</sect1>
+ </sect1>

xml/common_intro_convention.xml

@@ -49,7 +49,7 @@
   </listitem>
   <listitem>
    <para>
-    <systemitem class="username">user</systemitem>: The name of user or group
+    <systemitem class="username">user</systemitem>: The name of a user or group
    </para>
   </listitem>
   <listitem>
@@ -70,7 +70,7 @@
     As</guimenu> </menuchoice>: menu items, buttons
    </para>
   </listitem>
-  <listitem os="sles">
+  <listitem os="sles;slemicro">
    <para arch="x86_64">
     This paragraph is only relevant for the &x86-64; architectures. The
     arrows mark the beginning and the end of the text block.
@@ -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 end of the line:
+   </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>

xml/common_intro_feedback.xml

@@ -31,7 +31,7 @@
    <listitem>
     <para>
      For services and support options available for your product, see
-     <link xlink:href="http://www.suse.com/support/"/>.
+     <link xlink:href="https://www.suse.com/support/"/>.
     </para>
     <para>
      To open a service request, you need a &suse; subscription registered at
@@ -48,38 +48,41 @@
      Report issues with the documentation at <link condition="suse-product"
      xlink:href="https://bugzilla.suse.com/"/><link condition="community-project"
      xlink:href="https://bugzilla.opensuse.org/"/>.
-     A Bugzilla account is required.
     </para>
     <para>
-     To simplify this process, you can use the <guimenu>Report
-     Documentation Bug</guimenu> links next to headlines in the HTML
-     version of this document. These preselect the right product and
-     category in Bugzilla and add a link to the current section.
+     To simplify this process, click the <guimenu>Report
+     an issue</guimenu> icon next to a headline in the HTML
+     version of this document. This preselects the right product and
+     category in Bugzilla and adds a link to the current section.
      You can start typing your bug report right away.
     </para>
+    <para>
+     A Bugzilla account is required.
+    </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>Contributions</term>
    <listitem>
     <para>
-     To contribute to this documentation, use the <guimenu>Edit Source</guimenu>
-     links next to headlines in the HTML version of this document. They
-     take you to the source code on GitHub, where you can open a pull request.
+     To contribute to this documentation, click the <guimenu>Edit source
+     document</guimenu> icon next to a headline in the HTML version of
+     this document. This will take you to the source code on GitHub, where you
+     can open a pull request.</para>
+    <para>
      A GitHub account is required.
     </para>
     <note>
-     <title><guimenu>Edit Source</guimenu> only available for English</title>
+     <title><guimenu>Edit source document</guimenu> only available for English</title>
      <para>
-      The <guimenu>Edit Source</guimenu> links are only available for the
+      The <guimenu>Edit source document</guimenu> icons are only available for the
       English version of each document. For all other languages, use the
-      <guimenu>Report Documentation Bug</guimenu> links instead.
+      <guimenu>Report an issue</guimenu> icons instead.
      </para>
     </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>