Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix for bsc#1213642 #1562

Merged
merged 3 commits into from
Aug 1, 2023
Merged

Fix for bsc#1213642 #1562

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7400e95
Fix for bsc#1213642
fsundermeyer Jul 27, 2023
efccd07
fixed some issues
taroth21 Jul 27, 2023
4cf1e95
Apply suggestions from code review
fsundermeyer Jul 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 49 additions & 52 deletions xml/help_admin.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,39 @@
</dm:docmanager>
</info>
<para>
&productnamereg; comes with various sources of information and documentation,
many of which are already integrated into your installed system.
&productnamereg; comes with several sources of information and documentation,
available online or integrated into your installed system.
</para>
<variablelist>
<varlistentry>
<term>Product Documentation</term>
<listitem>
<para>
Extensive documentation for &productname; is available at <link os="sles"
xlink:href="https://documentation.suse.com/#sles"/><link os="sled"
xlink:href="https://documentation.suse.com/#sled"/><link os="osuse"
xlink:href="https://doc.opensuse.org"/>. Topics covered range from
deployment, upgrade, and system administration to virtualization, system
tuning, and security, among others.
fsundermeyer marked this conversation as resolved.
Show resolved Hide resolved
</para>
<para os="sles">
At <link xlink:href="https://documentation.suse.com/sbp-supported.html"/>
you find &suse;'s best practice series of documents covering hands-on
documentation on implementation scenarios. At <link
xlink:href="https://documentation.suse.com/trd-supported.html"/> our
technical reference documentation series provides guides on deploying
solution components from SUSE and its partners.
fsundermeyer marked this conversation as resolved.
Show resolved Hide resolved
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Documentation in <filename>/usr/share/doc</filename></term>
<listitem>
<para>
This traditional help directory holds documentation files and
release notes for your system. It contains also information of installed
packages in the subdirectory <filename>packages</filename>. Find more
detailed information in <xref linkend="sec-help-onboard-docdir"/>.
This directory holds release notes for your system (in the subdirectory
<filename>release-notes</filename>). It also contains information of
installed packages in the subdirectory <filename>packages</filename>. Find
more detailed information in <xref linkend="sec-help-onboard-docdir"/>.
</para>
</listitem>
</varlistentry>
Expand All @@ -46,9 +67,7 @@
<listitem>
<para>
The help center of the &gnome; desktop (&yelp;) provides central access to
the most important documentation resources on your system in searchable
form. These resources include online help for installed applications, man
pages, info pages, and the &suse; manuals delivered with your product.
the &gnome; desktop documentation.
</para>
</listitem>
</varlistentry>
Expand All @@ -69,16 +88,16 @@
<title>Documentation directory</title>

<para>
The traditional directory to find documentation on your
installed Linux system is <filename>/usr/share/doc</filename>. The
directory contains information about the packages installed on your system,
plus release notes, manuals and more.
The traditional directory to find documentation on your installed Linux
system is <filename>/usr/share/doc</filename>. The directory contains the
release notes and information about the packages installed on your system,
plus manuals and more.
</para>

<note>
<title>Contents depends on installed packages</title>
fsundermeyer marked this conversation as resolved.
Show resolved Hide resolved
<para>
In the Linux world, many manuals and other kinds of documentation are
In the Linux world, manuals and other kinds of documentation are
available in the form of packages, like software. How much and which
information you find in <filename>/usr/share/docs</filename> also depends
on the (documentation) packages installed. If you cannot find the
Expand All @@ -87,31 +106,16 @@
</para>
</note>

<sect2 xml:id="sec-help-onboard-docdir-manual">
<title>&suse; manuals</title>
<para>
We provide HTML and PDF versions of our books in different
languages. In the <filename>manual</filename> subdirectory, find HTML
versions of most of the &suse; manuals available for your product. For an
overview of all documentation available for your product refer to the
preface of the manuals.
</para>
<sect2 xml:id="sec-help-onboard-docdir-releasenotes">
<title>Release Notes</title>
fsundermeyer marked this conversation as resolved.
Show resolved Hide resolved
<para>
If more than one language is installed,
<filename>/usr/share/doc/manual</filename> may contain different language
versions of the manuals. The HTML versions of the &suse; manuals are also
available in the help center of both desktops. For information on where to
find the PDF and HTML versions of the books on your installation media,
refer to the &productname; Release Notes. They are available on your
installed system under <filename>/usr/share/doc/release-notes/</filename>
or online at your product-specific Web page at <link os="sles;sled"
xlink:href="https://www.suse.com/releasenotes//"/><link os="osuse"
xlink:href="https://doc.opensuse.org/release-notes/"/>.
We provide HTML, PDF, RTF and text versions of &productname; release
notes. They are available on your installed system under
<filename>/usr/share/doc/release-notes/</filename> or online at your
product-specific Web page at <link os="sles;sled"
xlink:href="https://www.suse.com/releasenotes//"/><link os="osuse"
xlink:href="https://doc.opensuse.org/release-notes/"/>.
</para>
<!--The PDF files are available on the DVD in the directory
<filename>docu</filename>. For HTML, install the packages
<systemitem>opensuse-manual_LANG</systemitem> (replace
<replaceable>LANG</replaceable> with your preferred language.)-->
</sect2>

<sect2 xml:id="sec-help-onboard-docdir-pkg">
Expand Down Expand Up @@ -142,7 +146,7 @@
</term>
<listitem>
<para>
Known bugs or malfunctions. Might also contain a link to a Bugzilla Web
Known bugs or malfunctions. May also contain a link to a Bugzilla Web
page where you can search all bugs.
</para>
</listitem>
Expand Down Expand Up @@ -205,7 +209,7 @@
</term>
<listitem>
<para>
Things that are not implemented yet, but might be in the future.
Features planned for the future.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -384,10 +388,10 @@
</table>

<para>
Each man page consists of several parts labeled <citetitle>NAME</citetitle>
, <citetitle>SYNOPSIS</citetitle> , <citetitle>DESCRIPTION</citetitle> ,
<citetitle>SEE ALSO</citetitle> , <citetitle>LICENSING</citetitle> , and
<citetitle>AUTHOR</citetitle> . There may be additional sections available
Each man page consists of several parts labeled <citetitle>NAME</citetitle>,
<citetitle>SYNOPSIS</citetitle>, <citetitle>DESCRIPTION</citetitle>,
<citetitle>SEE ALSO</citetitle>, <citetitle>LICENSING</citetitle>, and
<citetitle>AUTHOR</citetitle>. There may be additional sections available
depending on the type of command.
</para>
</sect1>
Expand Down Expand Up @@ -440,7 +444,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term>&productname; user community</term>
<term>User community</term>
<listitem>
<para>
<link os="osuse" xlink:href="https://forums.opensuse.org/">&opensuse;
Expand Down Expand Up @@ -473,7 +477,7 @@
<para>
The Linux Documentation Project (TLDP) is run by a team of volunteers who
write Linux-related documentation (see
<link xlink:href="https://www.tldp.org"/>). It is probably the most
<link xlink:href="https://www.tldp.org"/>). It is the most
comprehensive documentation resource for Linux. The set of documents
contains tutorials for beginners, but is mainly focused on experienced
users and professional system administrators. TLDP publishes HOWTOs,
Expand All @@ -483,12 +487,5 @@
</listitem>
</varlistentry>
</variablelist>

<para>
You can also try general-purpose search engines. For example, use the search
terms <literal>Linux CD-RW help</literal> or <literal>OpenOffice file
conversion problem</literal> if you have trouble with burning CDs or &libo;
file conversion.
</para>
</sect1>
</chapter>