Skip to content

Commit a6ec00b

Browse files
committed
doc-kit run (fetch updates)
1 parent 60a8d8a commit a6ec00b

6 files changed

Lines changed: 94 additions & 54 deletions

File tree

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,7 @@ build/
1010
.idea/
1111
*.code-workspace
1212
.vimrc
13+
worktree
14+
.worktree
15+
worktrees
16+
.worktrees

doc-kit.conf

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,13 @@
11
type: docbook5-book
22
variant: license-gfdl
33

4-
file: d5aba8356449342d0bac0a62116b85f1b44ee73d .gitignore
4+
file: ff3dfe8d7e05c08517d1b055b278bbc9f7e0aa01 .gitignore
55
file: c6b4745307e90c9b88905b434cbbaddc54e4541b .editorconfig
6-
file: 8b1be25d0f87bef381565de3a12a413c9bc2ed8c xml/product-entities.ent
7-
file: 087cd3de86a5e0d519c86e344fe03b7b8ce39587 xml/generic-entities.ent
6+
file: 078c37d26e1a91c41b1689f88b4e006929c134c4 xml/generic-entities.ent
87
file: a79a3bc929478668955564bab48aecc8502555f6 xml/network-entities.ent
9-
file: c56ebe2fc1aa5cb56c157ced29c11b881671d8df DC-example
10-
file: e2502a91415baa782e5da7ac292911b51f33bfb0 xml/MAIN.book-example.xml
11-
file: 66e8b8f8f7e7b88ff21d333c07adcc191cc156b2 xml/preface_example.xml
12-
file: e1105cf34cc726640a040f394dd3f1ea6c08acfd xml/cha_example_one.xml
13-
file: 8407fa21b722a4d6d825c766c94df4203a234929 xml/cha_example_two.xml
14-
file: da39a3ee5e6b4b0d3255bfef95601890afd80709 xml/example_doc_updates.xml
15-
file: 280cfae1f40eb4a3ef161d1706b3de7043b52d19 images/src/png/example.png
16-
file: bb1883074f56e583475571647a9b724e5e3b5d3f xml/common_intro_available_doc.xml
17-
file: 6b82b8fa32f3c8cd8c76e804e420ae4a9312ec27 xml/common_intro_support.xml
18-
file: a7dde5524c60c5ea24fa07a9381fd0111e55bae9 xml/common_intro_convention.xml
8+
file: 42fafc60a5e9622a138cede94d63a5b0bdc118c1 xml/common_intro_available_doc.xml
9+
file: ee8dbf17324e3e72b54bcb6fcc5dec7f7e4e1e9b xml/common_intro_support.xml
10+
file: 0e30d909a3d9305a496f3aecf3aa981f3f16f465 xml/common_intro_convention.xml
1911
file: 2af06d76aa36c3a85968e56e24440d56926cf81b xml/common_intro_feedback.xml
2012
file: 9f5f8165bfa8b076d80107d811b89c6c6bded8dd xml/common_copyright_gfdl.xml
2113
file: 7022e7485da1b892ea57faf858857981eb3644bc xml/common_legal.xml

xml/common_intro_available_doc.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
<!--based on 'Support Resources' listed at https://www.suse.com/support/kb/-->
4646
<listitem>
4747
<para>
48-
If you have run into an issue, also check out the Technical Information
48+
If you run into an issue, check out the Technical Information
4949
Documents (TIDs) that are available online at <link xlink:href="https://www.suse.com/support/kb/"/>.
5050
Search the &suse; Knowledgebase for known solutions driven by customer need.
5151
</para>

xml/common_intro_convention.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@
106106
<para>
107107
Commands can be split into two or multiple lines by a backslash character
108108
(<literal>\</literal>) at the end of a line. The backslash informs the shell that
109-
the command invocation will continue after the line's end:
109+
the command invocation will continue after the end of the line:
110110
</para>
111111
<screen>&prompt.user;<command>echo</command> a b \
112112
c d</screen>

xml/common_intro_support.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525
technology previews below.
2626
For details about the product lifecycle, see
2727
<link xlink:href="https://www.suse.com/lifecycle"/>.
28+
<!-- 2024-05-23 tbazant: resolves bsc#1221920 -->
29+
<phrase condition="virt">For the virtualization support status, see <xref
30+
linkend="cha-virt-support"/>.</phrase>
2831
</para>
2932
<para>
3033
If you are entitled to support, find details on how to collect information

xml/generic-entities.ent

Lines changed: 80 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
<!ENTITY prompt.root "<prompt role='root' xmlns='http://docbook.org/ns/docbook'># </prompt>">
4545
<!ENTITY prompt.user "<prompt xmlns='http://docbook.org/ns/docbook'>&gt; </prompt>">
4646
<!ENTITY prompt.sudo "<prompt xmlns='http://docbook.org/ns/docbook'>&gt; </prompt><command xmlns='http://docbook.org/ns/docbook'>sudo</command> ">
47+
<!ENTITY prompt.tr-up "<prompt role='root' xmlns='http://docbook.org/ns/docbook'>transactional update # </prompt>">
4748

4849

4950

@@ -56,9 +57,21 @@
5657

5758
<!-- SUSE PRODUCTS -->
5859

59-
<!ENTITY sliberty "&suse; Liberty Linux">
60-
<!ENTITY neuvector "NeuVector">
61-
<!ENTITY ranchelemental "Rancher Elemental">
60+
<!ENTITY sliberty "&suse; Multi-Linux Support">
61+
<!ENTITY neuvector "&ssecurity;">
62+
<!ENTITY sobservability "&suse; Observability">
63+
<!ENTITY ssecurity "&suse; Security">
64+
<!ENTITY sstorage "&suse; Storage">
65+
<!ENTITY svirtualization "&suse; Virtualization">
66+
<!ENTITY sappco "&suse; Application Collection">
67+
<!ENTITY ranchelemental "&rancherprime;: OS Manager">
68+
<!ENTITY ailibrary "AI Library">
69+
<!ENTITY suseaisuite "&suse; AI Suite">
70+
<!ENTITY suseai "&suse; AI">
71+
<!ENTITY rke2 "&rancherprime;: RKE2">
72+
<!ENTITY ranchermanager "&rancherprime;">
73+
<!ENTITY rancherappco "&rancherprime; Application Collection">
74+
<!ENTITY rancherprime "&suse; Rancher Prime">
6275

6376
<!-- SLE -->
6477
<!ENTITY jeos "JeOS"><!-- Just enough OS -->
@@ -76,29 +89,28 @@
7689
<!ENTITY sdk "&suse; Software Development Kit">
7790
<!ENTITY sles "&sle; Server">
7891
<!ENTITY sls "&sles;">
79-
<!ENTITY sles4sap "&sls; for &sap; Applications">
92+
<!ENTITY sles4sap "&sls; for &sap; applications">
8093
<!ENTITY s4s "&sles4sap;">
8194
<!ENTITY slem "&sle; Micro">
8295
<!ENTITY bci-product "&slea; Base Container Images">
8396

8497

85-
<!-- ALP -->
86-
<!ENTITY alp "Adaptable Linux Platform">
87-
<!ENTITY alpshort "ALP">
88-
<!ENTITY alp-dolomite "&alpshort;&nbsp;Dolomite">
89-
98+
<!-- ALP/SUSE Linux Framework One -->
99+
<!ENTITY slm "&suselinux; Micro">
100+
<!ENTITY slcc "&suselinux; Container Collection">
101+
<!ENTITY slcs "&suselinux; Container Solution">
90102

91103
<!-- SLE HA -->
92104

93105
<!ENTITY sleha "&sle; &ha;">
94106
<!ENTITY hageo "Geo Clustering for &sleha;">
95107

96-
<!-- SUSE Manager -->
97-
<!ENTITY susemgr "&suse; Manager">
98-
<!ENTITY suma "&susemgr;">
99-
<!ENTITY susemgrdb "&suse; Manager with Database">
100-
<!ENTITY susemgrproxy "&susemgr; Proxy">
101-
<!ENTITY smr "&susemgr; for Retail">
108+
109+
<!-- SUSE Multi-Linux Manager -->
110+
111+
<!ENTITY smlm "&suse; Multi-Linux Manager">
112+
<!ENTITY smlm-proxy "&smlm; Proxy">
113+
<!ENTITY smlm-retail "&smlm; for Retail">
102114

103115

104116
<!-- SUSE PRODUCT ACRONYMS (as approved in TermWeb 2023) -->
@@ -122,8 +134,7 @@
122134
<!ENTITY capa "SUSE&nbsp;CAP">
123135
<!ENTITY caaspa "SUSE&nbsp;CaaSP">
124136
<!ENTITY caspa "&caaspa;">
125-
<!ENTITY sumaa "SUMA">
126-
<!ENTITY smra "SUMA&nbsp;for&nbsp;Retail">
137+
<!ENTITY suseaia "&suse; AI">
127138

128139

129140
<!-- PRODUCT NAMES WITH (R) SIGN (incomplete) -->
@@ -133,7 +144,7 @@
133144
<!ENTITY slehpcreg "&slereg; High Performance Computing">
134145
<!ENTITY slertreg "&slereg; Real Time">
135146
<!ENTITY slsreg "&slereg; Server">
136-
<!ENTITY sles4sapreg "&slsreg; for &sap; Applications">
147+
<!ENTITY sles4sapreg "&slsreg; for &sap; applications">
137148
<!ENTITY slemreg "&slereg; Micro">
138149
<!ENTITY susemgrreg "&suse;&reg; Manager">
139150

@@ -179,6 +190,7 @@ use &deng;! -->
179190
<!ENTITY ms "Microsoft">
180191
<!ENTITY msreg "<trademark xmlns='http://docbook.org/ns/docbook' class='registered'>&ms;</trademark>">
181192
<!ENTITY nvidia "NVIDIA">
193+
<!ENTITY nvidiareg "&nvidia;*">
182194
<!ENTITY rh "Red Hat">
183195
<!ENTITY redhat "&rh;">
184196
<!ENTITY sap "SAP">
@@ -200,34 +212,46 @@ use &deng;! -->
200212
<!ENTITY rhla "RHEL">
201213
<!ENTITY rpios "Raspberry&nbsp;Pi&nbsp;OS">
202214
<!ENTITY centos "CentOS">
203-
204-
215+
<!ENTITY stackstate "StackState">
216+
<!ENTITY ollama "Ollama">
217+
<!ENTITY owui "Open WebUI">
218+
<!ENTITY milvus "Milvus">
219+
<!ENTITY chromadb "ChromaDB">
220+
<!ENTITY helm "Helm">
221+
<!ENTITY nvoperator "&nvidia; GPU Operator">
222+
<!ENTITY containerd "containerd">
223+
<!ENTITY langchain "LangChain">
224+
<!ENTITY apulsar "Apache Pulsar">
225+
<!ENTITY etcd "etcd">
226+
<!ENTITY minio "MinIO">
227+
<!ENTITY okta "Okta">
228+
<!ENTITY certmanager "cert-manager">
229+
230+
231+
<!-- NVIDIA products -->
232+
<!ENTITY cuda "CUDA">
233+
<!ENTITY cudareg "&cuda;*">
234+
<!ENTITY jetson "Jetson">
235+
<!ENTITY jetsonreg "&jetson;*">
236+
<!ENTITY jetpack "JetPack">
237+
<!ENTITY jetpackreg "&jetpack;*">
238+
<!ENTITY xavier "Xavier">
239+
<!ENTITY xavierreg "&xavier;*">
240+
<!ENTITY orin "Orin">
241+
<!ENTITY orinreg "&orin;*">
205242

206243
<!-- SLE DVD IMAGE NAMES -->
207244

208245
<!ENTITY allmodules "SLE-15-Packages">
209246

210247

211248
<!-- URLS -->
249+
<!-- use stand-alone only, not as part of URLs, see Style Guide-->
212250

213251
<!ENTITY dsc "https://documentation.suse.com">
214-
<!ENTITY dsc-sles "&dsc;/sles">
215-
<!ENTITY dsc-sled "&dsc;/sled">
216-
<!ENTITY dsc-ha "&dsc;/sle-ha">
217-
<!ENTITY dsc-sap "&dsc;/sles-sap">
218-
<!ENTITY dsc-ses "&dsc;/ses">
219-
<!ENTITY dsc-suma "&dsc;/suma">
220-
<!ENTITY dsc-caasp "&dsc;/suse-caasp">
221-
<!ENTITY dsc-cap "&dsc;/suse-cap">
222-
<!ENTITY dsc-soc "&dsc;/soc">
223-
224-
225252
<!ENTITY beta-www "https://susedoc.github.io">
226-
227253
<!ENTITY doo "https://doc.opensuse.org">
228-
229254
<!ENTITY sc-rn "https://www.suse.com/releasenotes">
230-
231255
<!ENTITY sccurl "https://scc.suse.com/">
232256

233257
<!-- HARDWARE ARCHITECTURES AND PLATFORMS -->
@@ -273,8 +297,7 @@ use &deng;! -->
273297
<!ENTITY ad "Active Directory">
274298
<!ENTITY ada "AD">
275299
<!ENTITY aide "AIDE">
276-
<!ENTITY alp-installer "Agama">
277-
<!ENTITY dinstaller "&alp-installer;">
300+
<!ENTITY agama "Agama">
278301
<!ENTITY ansible "Ansible">
279302
<!ENTITY ay "AutoYaST">
280303
<!ENTITY bcache "<systemitem xmlns='http://docbook.org/ns/docbook' class='resource'>bcache</systemitem>">
@@ -299,7 +322,7 @@ use &deng;! -->
299322
<!ENTITY kprobes "Kprobes">
300323
<!ENTITY krb "Kerberos">
301324
<!ENTITY kube "Kubernetes">
302-
<!ENTITY k3s "K3s">
325+
<!ENTITY k3s "&rancherprime;: K3s">
303326
<!ENTITY kubevirt "KubeVirt">
304327
<!ENTITY libo "LibreOffice">
305328
<!ENTITY lvmcache "<systemitem xmlns='http://docbook.org/ns/docbook' class='resource'>lvmcache</systemitem>">
@@ -328,7 +351,7 @@ use &deng;! -->
328351
<!ENTITY yelp "Help">
329352

330353

331-
<!-- ALP -->
354+
<!-- ALP/SUSE Linux Framework One -->
332355
<!ENTITY fuelignition-dld-site "https://ignite.opensuse.org">
333356
<!ENTITY virt-scenario "<command xmlns='http://docbook.org/ns/docbook'>virt-scenario</command>">
334357

@@ -352,6 +375,10 @@ use &deng;! -->
352375
<!ENTITY ingress "Ingress">
353376
<!ENTITY keepalived "Keepalived">
354377

378+
<!-- HPC -->
379+
380+
<!ENTITY hpc "High Performance Computing">
381+
<!ENTITY hpcm "HPC module">
355382

356383

357384
<!-- SLES FOR SAP -->
@@ -373,6 +400,7 @@ use &deng;! -->
373400
<!ENTITY bci "&slea; Base Container Image">
374401
<!ENTITY bcia "&slea; BCI">
375402
<!ENTITY netavark "Netavark">
403+
<!ENTITY compose "docker-compose">
376404

377405

378406

@@ -475,6 +503,7 @@ use &deng;! -->
475503
<!-- NETWORK PROTOCOLS -->
476504
<!ENTITY ptp "Precision Time Protocol">
477505
<!ENTITY ntp "Network Time Protocol">
506+
<!ENTITY nts "Network Time Security">
478507

479508

480509
<!-- Security -->
@@ -531,6 +560,7 @@ use &deng;! -->
531560
<!ENTITY sle_container_guide "Container Guide">
532561
<!ENTITY sle_pcidss_guide "&pcidss; (&pcidssa;) Guide">
533562
<!ENTITY sle_pcidss_guide_a "&pcidssa; Guide">
563+
<!ENTITY hpc_guide "&hpc; Guide">
534564

535565

536566
<!-- SLE Micro-specific -->
@@ -613,6 +643,17 @@ use &deng;! -->
613643
<!ENTITY susefirewallfiles "SuSEfirewall2">
614644
<!ENTITY mysql "&mariadb;">
615645

646+
647+
<!-- SUSE Manager -->
648+
<!ENTITY susemgr "&suse; Manager">
649+
<!ENTITY suma "&susemgr;">
650+
<!ENTITY susemgrdb "&suse; Manager with Database">
651+
<!ENTITY susemgrproxy "&susemgr; Proxy">
652+
<!ENTITY smr "&susemgr; for Retail">
653+
<!ENTITY sumaa "SUMA">
654+
<!ENTITY smra "SUMA&nbsp;for&nbsp;Retail">
655+
656+
616657
<!--SUSE Manager, old guide names -->
617658
<!ENTITY mgrclientconfguide "Client Configuration Guide">
618659
<!ENTITY mgrinstguide "Installation &amp; Troubleshooting Guide">
@@ -624,4 +665,4 @@ use &deng;! -->
624665
<!ENTITY smtguide "Subscription Management Tool Guide">
625666

626667
<!-- SLE HA, old productname entity -->
627-
<!ENTITY hasi "&ha;">
668+
<!ENTITY hasi "&ha;">

0 commit comments

Comments
 (0)