Skip to content

Commit b7aaac3

Browse files
chabowskichabowski
committed
Added common and test files to the new suse-ai repo
1 parent 3f1e44f commit b7aaac3

File tree

9 files changed

+1881
-0
lines changed

9 files changed

+1881
-0
lines changed

‎suse-ai/adoc/common_copyright_gfdl.adoc‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
////
2+
Please keep this document neatly formatted, because a text version
3+
for LICENSE.txt is created form this source. That means only the
4+
xml tags will be stripped, the rest of the formatting will appear
5+
in the txt file as is.
6+
////
7+
8+
9+
SUSE LLC
10+
11+
10 Canal Park Drive
12+
13+
Suite 200
14+
15+
Cambridge MA 02142
16+
17+
USA
18+
19+
http://www.suse.com/documentation
20+
21+
Copyright (C) 2018 SUSE LLC and contributors. All rights reserved.
22+
23+
Permission is granted to copy, distribute and/or modify this document
24+
under the terms of the GNU Free Documentation License, Version 1.2 or (at
25+
your option) version 1.3; with the Invariant Section being this copyright
26+
notice and license. A copy of the license version 1.2 is included in the
27+
section entitled `GNU Free Documentation License`.
28+
29+
For SUSE trademarks, see Trademark and Service Mark list http://www.suse.com/company/legal/
30+
Linux* is a registered trademark of Linus Torvalds. All other third party
31+
trademarks are the property of their respective owners. A trademark symbol
32+
(R), (TM) etc.) denotes a SUSE trademark; an asterisk (*)
33+
denotes a third party trademark.
34+
35+
36+
All information found in this book has been compiled with utmost attention
37+
to detail. However, this does not guarantee complete accuracy. Neither
38+
SUSE LLC, the authors, nor the translators shall be held liable for
39+
possible errors or the consequences thereof.

‎suse-ai/adoc/common_gfdl1.2_i.adoc‎

Lines changed: 214 additions & 0 deletions
Large diffs are not rendered by default.

‎suse-ai/adoc/common_sbp_legal_notice.adoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Copyright (C) 2006–2025 SUSE LLC and contributors. All rights reserved.
2+
3+
Permission is granted to copy, distribute and/or modify this document under the terms of
4+
the GNU Free Documentation License, Version 1.2 or (at your option) version 1.3; with the
5+
Invariant Section being this copyright notice and license. A copy of the license version 1.2
6+
is included in the section entitled "GNU Free Documentation License".
7+
8+
SUSE, the SUSE logo and YaST are registered trademarks of SUSE LLC in the United States
9+
and other countries. For SUSE trademarks, see https://www.suse.com/company/legal/.
10+
11+
Linux is a registered trademark of Linus Torvalds. All other names or trademarks mentioned in
12+
this document may be trademarks or registered trademarks of their respective owners.
13+
14+
Documents published as part of the SUSE Best Practices series have been contributed voluntarily
15+
by SUSE employees and third parties. They are meant to serve as examples of how particular
16+
actions can be performed. They have been compiled with utmost attention to detail.
17+
However, this does not guarantee complete accuracy. SUSE cannot verify that actions described
18+
in these documents do what is claimed or whether actions described have unintended consequences.
19+
SUSE LLC, its affiliates, the authors, and the translators may not be held liable for possible errors
20+
or the consequences thereof.
21+
22+
Below we draw your attention to the license under which the articles are published.

‎suse-ai/adoc/template-sbp-docinfo.xml‎

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
2+
<dm:bugtracker>
3+
<dm:url>https://github.com/SUSE/suse-best-practices/issues/new</dm:url>
4+
<dm:product>SAP Edge Integration Cell on SUSE</dm:product>
5+
</dm:bugtracker>
6+
</dm:docmanager>
7+
8+
<!--Add document title but outcomment it-->
9+
<!--<title>Edge Integration Cell on SUSE</title>-->
10+
11+
<!--Add meta data: -->
12+
13+
<!--select series name, usually Best Practices or Technical References: -->
14+
<meta name="series">Best Practices</meta>
15+
16+
<!--Only a limited set of categories is valid, these are:
17+
Third Party
18+
Cloud 
19+
Containerization
20+
Development Tools
21+
High Availability
22+
Tuning &amp; Performance
23+
SAP
24+
Security
25+
Storage
26+
Systems Management
27+
Virtualization
28+
29+
Only ONE category must be selected
30+
doc team has final say on category
31+
-->
32+
33+
<meta name="category">
34+
<phrase>SAP</phrase>
35+
</meta>
36+
37+
<!--Only a limited set of tasks is valid, supported are:
38+
Administration
39+
Artificial Intelligence
40+
Auditing
41+
Authentication
42+
Automation
43+
Backup &amp; Recovery
44+
Certification
45+
Cloud
46+
Clustering
47+
Compliance
48+
Configuration
49+
Containerization
50+
Container Management
51+
Data Intelligence
52+
Deployment
53+
Design
54+
Encryption
55+
High Availability
56+
Image Building
57+
Implementation
58+
Installation
59+
Integration
60+
Maintenance
61+
Migration
62+
Monitoring
63+
Packaging
64+
Security
65+
Storage 
66+
Subscription Management
67+
Troubleshooting
68+
Upgrade &amp; Update
69+
Virtualization
70+
Vulnerability
71+
Web
72+
73+
Maximum 3 tasks should be selected
74+
doc team has final say on tasks
75+
-->
76+
77+
<meta name="task">
78+
<phrase>Data Intelligence</phrase>
79+
<phrase>Containerization</phrase>
80+
<phrase>Installation</phrase>
81+
</meta>
82+
83+
<!--Add the title-->
84+
<meta name="title">SAP Edge Integration Cell on SUSE</meta>
85+
86+
<!--Add a description, 150 characters maximum, this is displayed on the index page in the portal,
87+
no sentence no period, example:-->
88+
<meta name="description">How to make use of SUSE’s full stack offerings for container workloads for an installation of SAP's Edge Integration Cell.</meta>
89+
90+
<!--Add a social description, 55 characters maximum, targets social media, acronyms allowed-->
91+
<meta name="social-descr">Install SAP's EIC on SUSE’s container workloads stack</meta>
92+
93+
<!--Add ALL SUSE portfolio product names with version numbers the document is valid for, examples-->
94+
<meta name="productname">
95+
<productname version="5.4">SUSE Linux Enterprise Micro</productname>
96+
<productname version="2">Rancher Kubernetes Engine</productname>
97+
<productname version="2.8.3">Rancher Prime</productname>
98+
<productname version="1.5.5">Longhorn</productname>
99+
</meta>
100+
101+
<!--Add ALL product names and versions, also from third parties, as shown below.
102+
This information is added to the cover of the document / start of the HTML:-->
103+
<meta name="platform">SUSE Linux Enterprise Micro 5.4</meta>
104+
<meta name="platform">Rancher Kubernetes Engine 2</meta>
105+
<meta name="platform">Longhorn</meta>
106+
<meta name="platform">Rancher Prime</meta>
107+
<meta name="platform">SAP Integration Suite</meta>
108+
109+
<!--Add author information-->
110+
<authorgroup>
111+
<author>
112+
<personname>
113+
<firstname>Kevin</firstname>
114+
<surname>Klinger</surname>
115+
</personname>
116+
<affiliation>
117+
<jobtitle>SAP Solution Architect</jobtitle>
118+
<orgname>SUSE</orgname>
119+
</affiliation>
120+
</author>
121+
<author>
122+
<personname>
123+
<firstname>Dominik</firstname>
124+
<surname>Mathern</surname>
125+
</personname>
126+
<affiliation>
127+
<jobtitle>SAP Solution Architect</jobtitle>
128+
<orgname>SUSE</orgname>
129+
</affiliation>
130+
</author>
131+
<author>
132+
<personname>
133+
<firstname>Dr. Ulrich</firstname>
134+
<surname>Schairer</surname>
135+
</personname>
136+
<affiliation>
137+
<jobtitle>SAP Solution Architect</jobtitle>
138+
<orgname>SUSE</orgname>
139+
</affiliation>
140+
</author>
141+
</authorgroup>
142+
143+
<!--Add SUSE logo, and if needed, partner logo extra, in the same style as SUSE logo-->
144+
<cover role="logos">
145+
<mediaobject>
146+
<imageobject role="fo">
147+
<imagedata fileref="suse.svg" width="5em" align="center" valign="bottom"/>
148+
</imageobject>
149+
<imageobject role="html">
150+
<imagedata fileref="suse.svg" width="152px" align="center" valign="bottom"/>
151+
</imageobject>
152+
<textobject><phrase>SUSE logo</phrase></textobject>
153+
</mediaobject>
154+
</cover>
155+
156+
<!--Add revision history date, plus revision comment if available or needed. Ensure date on top is the most current-->
157+
<!--To revhistory, add the article ID you defined in your adoc file, an put a rh- at the beginning.-->
158+
<revhistory xml:id="rh-art-sap-eic-slemicro54">
159+
<revision>
160+
<date>yyyy-mm-dd</date>
161+
<revdescription>
162+
<para>text text text</para>
163+
</revdescription>
164+
</revision>
165+
<revision>
166+
<date>yyyy-mm-dd older</date>
167+
<revdescription>
168+
<para>text text text</para>
169+
</revdescription>
170+
</revision>
171+
</revhistory>
172+
173+
<!--Add your abstract or executive summary. Ensure to always include the disclaimer shown in the second paragraph here-->
174+
<abstract>
175+
<para>
176+
text text text text
177+
</para>
178+
179+
<para>
180+
<emphasis role="strong">Disclaimer</emphasis>:
181+
Documents published as part of the SUSE Best Practices series have been contributed voluntarily
182+
by SUSE employees and third parties. They are meant to serve as examples of how particular
183+
actions can be performed. They have been compiled with utmost attention to detail.
184+
However, this does not guarantee complete accuracy. SUSE cannot verify that actions described
185+
in these documents do what is claimed or whether actions described have unintended consequences.
186+
SUSE LLC, its affiliates, the authors, and the translators may not be held liable for possible errors
187+
or the consequences thereof.
188+
</para>
189+
</abstract>

‎suse-ai/adoc/template-sbp.adoc‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
:docinfo:
2+
3+
// Defining article ID
4+
// Article ID is needed for revhistory in docinfo.xml file
5+
// As ID, use the SBP filename, or if too long, shorten filename wisely
6+
[#art-sbp-filename]
7+
8+
9+
// If you use variables, define them here. Examples below
10+
:sles: SUSE Linux Enterprise Server
11+
:sles4sap: SUSE Linux Enterprise Server for SAP applications
12+
:slm: SUSE Linux Micro
13+
14+
15+
= <document title>
16+
17+
== <first headline>
18+
19+
text text text text text text text
20+
21+
* bullet 1
22+
** sub-bullet 1
23+
* bullet 2
24+
** sub-bullet 2
25+
* bullet 3
26+
** sub-bullet 3
27+
28+
29+
NOTE: text text text
30+
31+
// if you need to insert a page break, use:
32+
++++
33+
<?pdfpagebreak?>
34+
++++
35+
36+
===<second headline>
37+
38+
text text text text
39+
40+
// include a link with text, example:
41+
https://help.sap.com/docs/integration-suite/sap-integration-suite/setting-up-and-managing-edge-integration-cell[Installation Guide at help.sap.com]
42+
43+
//include content from another adoc document, example
44+
include::SAP-EIC-SLEMicro.adoc[SLEMicro]
45+
46+
// include image with title, example
47+
image::EIC-Rancher-Kubectl-Shell.png[title=Rancher Shell Overview,scaledwidth=99%]
48+
49+
// insert code block or screen or command
50+
----
51+
$ helm registry login dp.apps.rancher.io/charts -u <yourUser> -p <your-token>
52+
----
53+
54+
// add a section ID
55+
[#section-id-name]
56+
== <first headline>
57+
58+
// mark command or package, example
59+
`kubectl`
60+
61+
// make text bold, example
62+
*Storage*
63+
64+
// make text italic, example
65+
_Secret type_
66+
67+
68+
// add pagebreak at the end of your content
69+
++++
70+
<?pdfpagebreak?>
71+
++++
72+
73+
// At the very end of the document, you need to add GPDL and Legal Notice
74+
75+
76+
:leveloffset: 0
77+
// Standard SUSE Best Practices includes
78+
== Legal notice
79+
include::common_sbp_legal_notice.adoc[]
80+
81+
++++
82+
<?pdfpagebreak?>
83+
++++
84+
85+
// Standard SUSE Best Practices includes
86+
:leveloffset: 0
87+
include::common_gfdl1.2_i.adoc[]

0 commit comments

Comments
 (0)