Skip to content

Commit

Permalink
doc-kit run May 2023 (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
tahliar authored May 22, 2023
1 parent 525f0c8 commit 8908bb3
Show file tree
Hide file tree
Showing 9 changed files with 122 additions and 64 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@
build/
.vscode/
.idea/
*.code-workspace
15 changes: 8 additions & 7 deletions doc-kit.conf
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
type: docbook5-book
variant: license-gfdl

file: dc865ed00674536288a1e5a78ba07fe138aaabde .gitignore
file: 50fc57833230d2afd445ef11a36e81d2850993b1 .gitignore
file: c6b4745307e90c9b88905b434cbbaddc54e4541b .editorconfig
file: 52057b72aa89089dc36d5edc422a2ecb4c6ca48b xml/generic-entities.ent
file: e18430714fe3af85fe62bea62b50140d8b5edf5a 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: 47e64cba1ddfdfa57fec4da6591e7259ac38afb5 xml/generic-entities.ent
file: a79a3bc929478668955564bab48aecc8502555f6 xml/network-entities.ent
file: 877a69c29d30bd89aa36d79dd96c72dbde4a0ed8 xml/common_intro_available_doc.xml
file: 2024e3be75c45cf26a2b076eee30c697a6e819a1 xml/common_intro_support.xml
file: 578bc097d6cb4ef8aa08dbf4f1bf4400cae124f6 xml/common_intro_convention.xml
file: fcb8648dbfbe5a036547347e2affbeb353622162 xml/common_intro_feedback.xml
file: 1c8497ffe563b59832de4b0e106082aa4932a528 xml/common_copyright_gfdl.xml
file: 7022e7485da1b892ea57faf858857981eb3644bc xml/common_legal.xml
file: a0ece304c6960ddb302edea950b56d8816e89e23 xml/common_license_gfdl1.2.xml
file: de23bd53cd811ab5e13a39b302f32b16be9956cd xml/common_license_gfdl1.2.xml
63 changes: 35 additions & 28 deletions xml/common_intro_available_doc.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?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"
Expand All @@ -10,50 +10,57 @@
<!ENTITY % entities SYSTEM "generic-entities.ent">
%entities;
]>

<sect1 xml:lang="en"
xmlns="http://docbook.org/ns/docbook" version="5.1"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Available documentation</title>

<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 usually be found in the English
language version.
</para>
</note>
<para>
In addition, the product documentation
is usually available in your installed system under
<filename>/usr/share/doc/manual</filename>.
</para>
<para>
The following documentation is available for this product:
</para>
<info>
<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
<dm:translation>yes</dm:translation>
</dm:docmanager>
</info>

<variablelist>
<varlistentry>
<term><xref linkend="book-example"/></term>
<term>Online documentation</term>
<listitem>
<para>
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 condition="suse-product">
<term>Release notes</term>
<listitem>
<para>
Abstract of Example Guide.
For release notes, see
<link xlink:href="https://www.suse.com/releasenotes/"/>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><xref linkend="book-example"/></term>
<term>In your system</term>
<listitem>
<para>
Abstract of Example Guide 2.
For offline use, find documentation in your installed system under
<filename>/usr/share/doc</filename>. Many commands are also described in
detail 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>
</varlistentry>
</variablelist>
</sect1>
</sect1>
4 changes: 2 additions & 2 deletions xml/common_intro_convention.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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.
Expand Down
26 changes: 15 additions & 11 deletions xml/common_intro_feedback.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,32 +48,36 @@
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>
Expand Down
6 changes: 3 additions & 3 deletions xml/common_intro_support.xml
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@
to provide glimpses into upcoming innovations.
Technology previews are included for your convenience to give you a chance
to test new technologies within your environment.
We would appreciate your feedback!
We would appreciate your feedback.
If you test a technology preview, please contact your &suse; representative
and let them know about your experience and use cases.
Your input is helpful for future development.
Expand All @@ -135,7 +135,7 @@
<listitem>
<para>
Technology previews are still in development.
Therefore, they may be functionally incomplete, unstable, or in other ways
Therefore, they may be functionally incomplete, unstable, or otherwise
<emphasis>not</emphasis> suitable for production use.
</para>
</listitem>
Expand Down Expand Up @@ -169,7 +169,7 @@
</itemizedlist>
<para>
For an overview of technology previews shipped with your product, see the
release notes at <link xlink:href="&rn-url;"/>.
release notes at <link xlink:href="&sc-rn;"/>.
</para>
</sect2>
</sect1>
7 changes: 7 additions & 0 deletions xml/common_license_gfdl1.2.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>GNU Free Documentation License</title>
<info>
<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
<dm:bugtracker></dm:bugtracker>
<dm:translation>no</dm:translation>
</dm:docmanager>
</info>


<para>
Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc. 51 Franklin St,
Expand Down
62 changes: 50 additions & 12 deletions xml/generic-entities.ent
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<!ENTITY exampleuserIIfull "Wilber Fox">

<!ENTITY exampleuserIII "<systemitem xmlns='http://docbook.org/ns/docbook' class='username'>exampleuserIII_plain</systemitem>">
<!ENTITY exampleuserIII_plain "geeko">
<!ENTITY exampleuserIII_plain "suzanne">
<!ENTITY exampleuserIIIfull "Suzanne Geeko">

<!ENTITY examplegroup "<systemitem xmlns='http://docbook.org/ns/docbook' class='groupname'>users</systemitem>">
Expand All @@ -56,8 +56,11 @@

<!-- SUSE PRODUCTS -->

<!ENTITY sliberty "&suse; Liberty Linux">

<!-- SLE -->
<!ENTITY jeos "JeOS"><!-- Just enough OS -->
<!ENTITY jeosfirstboot "&jeos; Firstboot">
<!ENTITY minvm "Minimal VM">
<!ENTITY leanos "Unified Installer">
<!ENTITY sle "&suse; Linux Enterprise">
Expand All @@ -74,7 +77,13 @@
<!ENTITY sles4sap "&sls; for &sap; Applications">
<!ENTITY s4s "&sles4sap;">
<!ENTITY slem "&sle; Micro">
<!ENTITY bci "&slea; Base Container Image">
<!ENTITY bcia "&slea; BCI">
<!ENTITY dinstaller "D-Installer">

<!-- ALP -->
<!ENTITY alp "Adaptable Linux Platform">
<!ENTITY alpshort "ALP">

<!-- SLE HA -->
<!ENTITY hasi "&ha; Extension">
Expand Down Expand Up @@ -188,6 +197,7 @@ use &deng;! -->
<!ENTITY rhel "&rh; Enterprise Linux">
<!ENTITY rhla "RHEL">
<!ENTITY rpios "Raspberry&nbsp;Pi&nbsp;OS">
<!ENTITY centos "CentOS">



Expand Down Expand Up @@ -265,35 +275,42 @@ use &deng;! -->
<!ENTITY bcache "<systemitem xmlns='http://docbook.org/ns/docbook' class='resource'>bcache</systemitem>">
<!ENTITY chrony "<systemitem xmlns='http://docbook.org/ns/docbook' class='resource'>chrony</systemitem>">
<!ENTITY chronyc "<command xmlns='http://docbook.org/ns/docbook'>chronyc</command>">
<!ENTITY debuginfod "<systemitem xmlns='http://docbook.org/ns/docbook' class='daemon'>debuginfod</systemitem>">
<!ENTITY gnome "GNOME">
<!ENTITY gdm "&gnome; Display Manager">
<!ENTITY gdmshort "GDM">
<!ENTITY grub "GRUB&nbsp;2">
<!ENTITY grub-efi "GRUB&nbsp;2 for EFI">
<!ENTITY kdump "Kdump">
<!ENTITY kexec "Kexec">
<!ENTITY kg "kGraft">
<!ENTITY klp "Kernel Live Patching">
<!ENTITY klpa "KLP">
<!ENTITY ulp "userspace live patching">
<!ENTITY ulp "user space live patching">
<!ENTITY ulpa "ULP">
<!ENTITY kiwi "KIWI">
<!ENTITY kprobes "Kprobes">
<!ENTITY krb "Kerberos">
<!ENTITY kube "Kubernetes">
<!ENTITY k3s "K3s">
<!ENTITY kubevirt "KubeVirt">
<!ENTITY libo "LibreOffice">
<!ENTITY lvmcache "<systemitem xmlns='http://docbook.org/ns/docbook' class='resource'>lvmcache</systemitem>">
<!ENTITY nm "NetworkManager">
<!ENTITY ovs "<phrase role='productname' xmlns='http://docbook.org/ns/docbook'>Open vSwitch</phrase>">
<!ENTITY pk "PolKit">
<!ENTITY pk "Polkit">
<!ENTITY rmt "RMT">
<!ENTITY rmtool "Repository Mirroring Tool">
<!ENTITY salt "Salt">
<!ENTITY samba "Samba">
<!ENTITY scchvc "<command xmlns='http://docbook.org/ns/docbook'>scc-hypervisor-collector</command>">
<!ENTITY selnx "SELinux">
<!ENTITY smaster "&salt; Master">
<!ENTITY sminion "&salt; Minion">
<!ENTITY sudo "<command xmlns='http://docbook.org/ns/docbook'>sudo</command>">
<!ENTITY suseconnect "SUSEConnect">
<!ENTITY tr-up "<command xmlns='http://docbook.org/ns/docbook'>transactional-update</command>">
<!ENTITY tr-up-shell "<command xmlns='http://docbook.org/ns/docbook'>transactional-update shell</command>">
<!ENTITY xgeneric "X Window System">
<!ENTITY xvendor "X.Org">
<!ENTITY yast "YaST">
Expand All @@ -319,6 +336,8 @@ use &deng;! -->
<!ENTITY pace "Pacemaker">
<!ENTITY rear "ReaR">
<!ENTITY stonith "STONITH">
<!ENTITY ingress "Ingress">
<!ENTITY keepalived "Keepalived">



Expand Down Expand Up @@ -394,6 +413,15 @@ use &deng;! -->
<!ENTITY postgresql "PostgreSQL">
<!ENTITY powertop "powerTOP">
<!ENTITY stap "SystemTap">
<!ENTITY zypper "Zypper">
<!ENTITY cockpit "Cockpit">
<!ENTITY ignition "Ignition">
<!ENTITY combustion "Combustion">
<!ENTITY ceph "Ceph">
<!ENTITY rook "Rook">
<!ENTITY grafana "Grafana">
<!ENTITY prometheus "Prometheus">
<!ENTITY fuelignition "Fuel Ignition">



Expand Down Expand Up @@ -426,16 +454,29 @@ use &deng;! -->
<!ENTITY ntp "Network Time Protocol">


<!-- MISCELLANEOUS -->

<!ENTITY iscsi "iSCSI">
<!ENTITY netteam "Network Teaming">
<!-- Security -->
<!ENTITY openscap "OpenSCAP">
<!ENTITY ssg "SCAP Security Guide">
<!ENTITY pcidss "Payment Card Industry Data Security Standard">
<!ENTITY pcidssa "PCI DSS">
<!ENTITY disa "Defense Information Systems Agency">
<!ENTITY disaa "DISA">
<!ENTITY stig "Security Technical Implementation Guide">
<!ENTITY stiga "STIG">
<!ENTITY stigviewer "&disaa; &stiga; Viewer">
<!ENTITY cis "Center for Internet Security">
<!ENTITY cisa "CIS">
<!ENTITY hipaa "Health Insurance Portability and Accountability Act">
<!ENTITY hipaaa "HIPAA">
<!ENTITY uefisecboot "UEFI Secure Boot">


<!-- MISCELLANEOUS -->

<!ENTITY iscsi "iSCSI">
<!ENTITY netteam "Network Teaming">



<!-- BOOK NAMES -->

Expand Down Expand Up @@ -475,6 +516,7 @@ use &deng;! -->

<!-- HA -->
<!ENTITY haguide "<citetitle xmlns='http://docbook.org/ns/docbook'>Administration Guide</citetitle>">
<!ENTITY haquick "<citetitle xmlns='http://docbook.org/ns/docbook'>Installation and Setup Quick Start</citetitle>">
<!ENTITY geoguide "<citetitle xmlns='http://docbook.org/ns/docbook'>&geo; Clustering Guide</citetitle>">
<!ENTITY geoquick "<citetitle xmlns='http://docbook.org/ns/docbook'>&geo; Clustering Quick Start</citetitle>">
<!ENTITY nfsquick "<citetitle xmlns='http://docbook.org/ns/docbook'>Highly Available NFS Storage with DRBD and Pacemaker</citetitle>">
Expand Down Expand Up @@ -521,11 +563,6 @@ use &deng;! -->
<!ENTITY cap "&suse; Cloud Application Platform">


<!-- SUSE Enterprise Storage -->
<!ENTITY ceph "Ceph">
<!ENTITY rook "Rook">


<!-- Studio -->

<!ENTITY susestudio "&suse; Studio">
Expand All @@ -551,3 +588,4 @@ use &deng;! -->

<!-- SLE, old guide names -->
<!ENTITY sle_jeos_quick "<citetitle xmlns='http://docbook.org/ns/docbook'>&jeos; Quick Start</citetitle>">
<!ENTITY smtguide "<citetitle xmlns='http://docbook.org/ns/docbook'>Subscription Management Tool Guide</citetitle>">
Loading

0 comments on commit 8908bb3

Please sign in to comment.