Skip to content

Commit

Permalink
doc-kit run: fetch updates
Browse files Browse the repository at this point in the history
  • Loading branch information
taroth21 committed Dec 27, 2023
1 parent 6eea4de commit 64355b0
Show file tree
Hide file tree
Showing 7 changed files with 86 additions and 40 deletions.
12 changes: 6 additions & 6 deletions doc-kit.conf
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ variant: license-gfdl

file: d5aba8356449342d0bac0a62116b85f1b44ee73d .gitignore
file: c6b4745307e90c9b88905b434cbbaddc54e4541b .editorconfig
file: 71bdb8014805fa7e20ee8f0cbb78b5245b7f69ef xml/generic-entities.ent
file: 1cce617c0f95dd2dd3442220ad4220153cfdac93 xml/generic-entities.ent
file: a79a3bc929478668955564bab48aecc8502555f6 xml/network-entities.ent
file: 78cb16c93e8a51b4c9ec32c4b30466b87979fb6a xml/common_intro_available_doc.xml
file: bb1883074f56e583475571647a9b724e5e3b5d3f xml/common_intro_available_doc.xml
file: 6b82b8fa32f3c8cd8c76e804e420ae4a9312ec27 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: a7dde5524c60c5ea24fa07a9381fd0111e55bae9 xml/common_intro_convention.xml
file: 2af06d76aa36c3a85968e56e24440d56926cf81b xml/common_intro_feedback.xml
file: 9f5f8165bfa8b076d80107d811b89c6c6bded8dd xml/common_copyright_gfdl.xml
file: 7022e7485da1b892ea57faf858857981eb3644bc xml/common_legal.xml
file: de23bd53cd811ab5e13a39b302f32b16be9956cd xml/common_license_gfdl1.2.xml
file: d8d35b7d60a7800407fa0a8f0c0d83f7458a46d3 xml/common_license_gfdl1.2.xml
2 changes: 1 addition & 1 deletion xml/common_copyright_gfdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,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.
Expand Down
11 changes: 11 additions & 0 deletions xml/common_intro_available_doc.xml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,17 @@
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>&suse; Knowledgebase</term>
<!--based on 'Support Resources' listed at https://www.suse.com/support/kb/-->
<listitem>
<para>
If you have run into an issue, also 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 condition="suse-product">
<term>Release notes</term>
<listitem>
Expand Down
23 changes: 20 additions & 3 deletions xml/common_intro_convention.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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 line's end:
</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>
Expand Down
5 changes: 2 additions & 3 deletions xml/common_intro_feedback.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -82,8 +82,7 @@
</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>
Expand Down
2 changes: 1 addition & 1 deletion xml/common_license_gfdl1.2.xml
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@
Free Documentation License from time to time. Such new versions will be
similar in spirit to the present version, but may differ in detail to address
new problems or concerns. See
<link xlink:href="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</link>.
<link xlink:href="https://www.gnu.org/copyleft/">https://www.gnu.org/copyleft/</link>.
</para>

<para>
Expand Down
71 changes: 45 additions & 26 deletions xml/generic-entities.ent
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,13 @@
<!-- SUSE PRODUCTS -->

<!ENTITY sliberty "&suse; Liberty Linux">
<!ENTITY neuvector "NeuVector">
<!ENTITY ranchelemental "Rancher Elemental">

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


<!-- ALP -->
<!ENTITY alp "Adaptable Linux Platform">
<!ENTITY alpshort "ALP">
<!ENTITY alp-dolomite "&alpshort;&nbsp;Dolomite">


<!-- SLE HA -->

Expand Down Expand Up @@ -181,7 +184,6 @@ use &deng;! -->
<!ENTITY sap "SAP">
<!ENTITY vmware "VMware">


<!-- THIRD-PARTY PRODUCTS -->

<!ENTITY hana "&sap; HANA">
Expand Down Expand Up @@ -271,6 +273,9 @@ use &deng;! -->
<!ENTITY ad "Active Directory">
<!ENTITY ada "AD">
<!ENTITY aide "AIDE">
<!ENTITY alp-installer "Agama">
<!ENTITY dinstaller "&alp-installer;">
<!ENTITY ansible "Ansible">
<!ENTITY ay "AutoYaST">
<!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>">
Expand All @@ -282,12 +287,14 @@ use &deng;! -->
<!ENTITY grub "GRUB&nbsp;2">
<!ENTITY grub-efi "GRUB&nbsp;2 for EFI">
<!ENTITY kdump "Kdump">
<!ENTITY kea "Kea">
<!ENTITY kexec "Kexec">
<!ENTITY kg "kGraft">
<!ENTITY klp "Kernel Live Patching">
<!ENTITY klpa "KLP">
<!ENTITY ulp "user space live patching">
<!ENTITY ulpa "ULP">
<!ENTITY keylime "Keylime">
<!ENTITY kiwi "KIWI&nbsp;NG">
<!ENTITY kprobes "Kprobes">
<!ENTITY krb "Kerberos">
Expand All @@ -307,10 +314,12 @@ use &deng;! -->
<!ENTITY selnx "SELinux">
<!ENTITY smaster "&salt; Master">
<!ENTITY sminion "&salt; Minion">
<!ENTITY snapper "Snapper">
<!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 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 tr-up-run "<command xmlns='http://docbook.org/ns/docbook'>transactional-update run</command>">
<!ENTITY xgeneric "X Window System">
<!ENTITY xvendor "X.Org">
<!ENTITY yast "YaST">
Expand All @@ -319,6 +328,10 @@ use &deng;! -->
<!ENTITY yelp "Help">


<!-- ALP -->
<!ENTITY fuelignition-dld-site "https://ignite.opensuse.org">
<!ENTITY virt-scenario "<command xmlns='http://docbook.org/ns/docbook'>virt-scenario</command>">


<!-- HA -->

Expand Down Expand Up @@ -357,16 +370,22 @@ use &deng;! -->
<!ENTITY podman "Podman">
<!ENTITY buildah "Buildah">
<!ENTITY k8s "Kubernetes">
<!ENTITY bci "&slea; Base Container Image">
<!ENTITY bcia "&slea; BCI">
<!ENTITY netavark "Netavark">



<!-- VIRTUALIZATION -->

<!ENTITY amdsev "AMD SEV">
<!ENTITY dom0 "Dom0">
<!ENTITY esx "&vmware; ESX">
<!ENTITY gpuback "GPU Pass-Through">
<!ENTITY hyperv "&ms; Hyper-V">
<!ENTITY kvm "KVM">
<!ENTITY kvmserver "&kvm; Server">
<!ENTITY kvmclient "&kvm; Client">
<!ENTITY libvirt "<systemitem xmlns='http://docbook.org/ns/docbook' class='library'>libvirt</systemitem>">
<!ENTITY pciback "PCI Pass-Through">
<!ENTITY qemu "QEMU">
Expand Down Expand Up @@ -425,6 +444,7 @@ use &deng;! -->




<!-- HARDWARE TECHNOLOGIES -->

<!ENTITY nvme "NVMe">
Expand All @@ -449,6 +469,8 @@ use &deng;! -->
<!ENTITY usbflashdrive "USB flash drive">
<!ENTITY usbflashdrivecap "USB Flash Drive">

<!ENTITY infiniband "InfiniBand">


<!-- NETWORK PROTOCOLS -->
<!ENTITY ptp "Precision Time Protocol">
Expand Down Expand Up @@ -476,6 +498,8 @@ use &deng;! -->

<!ENTITY iscsi "iSCSI">
<!ENTITY netteam "Network Teaming">
<!ENTITY opensm "opensm">
<!ENTITY subnetmanager "Subnet Manager">



Expand Down Expand Up @@ -533,30 +557,25 @@ use &deng;! -->



<!-- CHARACTER ENTITIES -->

<!ENTITY euro "&#x20AC;">
<!ENTITY thrdmrk "*">



<!-- SYSTEM ENTITIES FOR DOCBOOK 5 -->

<!ENTITY % sgml.features "IGNORE">
<!ENTITY % xml.features "INCLUDE">
<!ENTITY % dbcent PUBLIC "-//OASIS//ENTITIES DocBook Character Entities V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/dbcentx.mod">
%dbcent;

<!-- DOCBOOK 4 ENTITITES -->

<!ENTITY dash "&#x02010;" ><!--HYPHEN -->
<!ENTITY ndash "&#x02013;" ><!--EN DASH -->
<!ENTITY trade "&#x02122;" ><!--TRADE MARK SIGN -->
<!ENTITY ast "&#x0002A;" ><!--ASTERISK -->
<!ENTITY asymp "&#x02248;" ><!--ALMOST EQUAL TO -->
<!ENTITY checkmark "&#x02714;" ><!--HEAVY CHECK MARK-->
<!ENTITY commat "&#x00040;" ><!--COMMERCIAL AT -->
<!ENTITY copy "&#x000A9;" ><!--COPYRIGHT SIGN -->
<!ENTITY sol "&#x0002F;" ><!--SOLIDUS -->
<!ENTITY rdquo "&#x0201D;" ><!--RIGHT DOUBLE QUOTATION MARK -->
<!ENTITY dash "&#x02010;" ><!--HYPHEN -->
<!ENTITY euro "&#x020AC;" ><!--EURO SIGN -->
<!ENTITY hellip "&#x02026;" ><!--HORIZONTAL ELLIPSIS -->
<!ENTITY ldquo "&#x0201C;" ><!--LEFT DOUBLE QUOTATION MARK -->
<!ENTITY mdash "&#x02014;" ><!--EM DASH -->
<!ENTITY nbsp "&#x000A0;" ><!--NO-BREAK SPACE -->
<!ENTITY ndash "&#x02013;" ><!--EN DASH -->
<!ENTITY rdquo "&#x0201D;" ><!--RIGHT DOUBLE QUOTATION MARK -->
<!ENTITY reg "&#x000AE;" ><!--REGISTERED SIG -->
<!ENTITY sol "&#x0002F;" ><!--SOLIDUS -->
<!ENTITY thrdmrk "*" ><!--ASTERISK -->
<!ENTITY trade "&#x02122;" ><!--TRADE MARK SIGN -->

<!-- LEGACY COMPATIBILITY ENTITIES -->
<!-- Do not use in new documentation. -->
Expand Down

0 comments on commit 64355b0

Please sign in to comment.