Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -289,3 +289,4 @@ audit_reports/
git_repos/
.DS_Store
lean_audit.txt
output/
56 changes: 56 additions & 0 deletions src/docbuild/config/xml/data/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Portal Configuration

This directory contains:

* A RELAX NG schema (`src/docbuild/config/xml/data/product-config-schema.rnc`).
It's the successor of the previous Docserv product schema.
* An example `config.d` directory.

## File structure

The `config.d` directory contains several subdirectories

```text
config.d/
├── categories/
│ ├── [... more languages ...]
│ ├── de-de.xml
│ └── en-us.xml
├── cloudnative/
│ ├── [... similar to sles/... ]
│ └── cloudnative.xml
├── portal.xml
└── sles/
├── desc
│ ├── [... more languages ...]
│ ├── descriptions.xml
│ ├── de-de.xml
│ └── en-us.xml
├── docsets
│ ├── [... more docsets ...]
│ └── 16.0.xml
└── sles.xml
```

* `config.d/`: the configuration directory with all portal configuration
* `categories/`: A directory that contains all categories.
* `portal.xml`: The main entry file which references all categories and
product configuration.
* `sles/sles.xml`: The main product configuration for SLES.
* `sles/desc/`: contains all language specific
* `sles/docsets/`: contains all docsets of a product.
Depending on the complexity of the product, this may not always be
needed. For SLES, it would probably useful.

## Creating combined config

```shell
xmllint --xinclude \
--output src/docbuild/config/xml/data/stitchfile.xml \
src/docbuild/config/xml/data/config.d/portal.xml
```


## Additional Sources

https://confluence.suse.com/x/0QB5e
6 changes: 6 additions & 0 deletions src/docbuild/config/xml/data/config.d/categories.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-model href="file:../portal-config-schema.rnc" type="application/relax-ng-compact-syntax"?>
<categories xmlns:xi="http://www.w3.org/2001/XInclude">
<xi:include href="categories/en-us.xml" />
<xi:include href="categories/de-de.xml" />
</categories>
8 changes: 8 additions & 0 deletions src/docbuild/config/xml/data/config.d/categories/de-de.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml-model href="file:../../portal-config-schema.rnc" type="application/relax-ng-compact-syntax"?>

<category lang="de-de">
<language id="about" title="Über" />
<language id="deployment" title="Deployment" />
<language id="inital-config" title="Initiale Konfiguration" />
<!-- ... more entries ... -->
</category>
8 changes: 8 additions & 0 deletions src/docbuild/config/xml/data/config.d/categories/en-us.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml-model href="file:../../portal-config-schema.rnc" type="application/relax-ng-compact-syntax"?>

<category lang="en-us">
<language id="about" title="About" />
<language id="deployment" title="Deployment" />
<language id="inital-config" title="Initial configuration" />
<!-- ... more entries ... -->
</category>
Empty file.
22 changes: 22 additions & 0 deletions src/docbuild/config/xml/data/config.d/portal.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-model href="file:../portal-config-schema.rnc" type="application/relax-ng-compact-syntax"?>
<portal xmlns:xi="http://www.w3.org/2001/XInclude" schemaversion="7.0">

<xi:include href="categories.xml" />

<productfamilies>
<item id="linux">Linux</item>
<item id="cn">Cloud Native</item>
<item id="suse-edge">SUSE Edge</item>
<item id="suse-ai">SUSE AI</item>
</productfamilies>
<series>
<item id="pas">Products &amp; Solutions</item>
<item id="sbp">SUSE Best Practices</item>
<item id="trd">Technical References</item>
<item id="rn">Release Notes</item>
</series>

<xi:include href="sles/sles.xml" />

</portal>
216 changes: 216 additions & 0 deletions src/docbuild/config/xml/data/config.d/sles/16.0.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,216 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-model href="../../../portal-config-schema.rnc" type="application/relax-ng-compact-syntax"?>
<docset setid="16.0" lifecycle="supported">
<version>16.0</version>
<canonical>sles/16.0</canonical>

<!--<descriptions>
</descriptions>-->

<resources>
<git remote="https://github.com/SUSE/doc-modular.git"/>
<locale lang="en-us">
<branch>maintenance/SLE16.0</branch>
<!--************************ about ************************-->
<deliverable category="about" type="dc">
<git remote="https://github.com/SUSE/doc-modular.git"/>
<dc>DC-SLE-comparison</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="about">
<dc>DC-SLE-differences-faq</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="about">
<dc>DC-SLE-packages-lifecycle</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="about">
<dc>DC-SLE-os-identification</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<!--**************** deployement ****************-->
<deliverable category="deployment">
<dc>DC-SLES-x86-64-agama-based-installation</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="deployment">
<dc>DC-SLES-s390-agama-based-installation</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="deployment">
<dc>DC-SLES-ppc-agama-based-installation</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="deployment">
<dc>DC-SLES-x86-64-agama-automated-installation</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="deployment">
<dc>DC-SLES-PXE-server</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="deployment">
<dc>DC-SLES-deployment-pxe-client</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<!--***************** update-upgrade *****************-->
<deliverable category="update-upgrade">
<dc>DC-SLES-klp</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="update-upgrade">
<dc>DC-SLES-ulp</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="update-upgrade">
<dc>DC-SLES-upgrading</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<!--*************** administration ***************-->
<deliverable category="administration">
<dc>DC-SLES-Ansible</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-ansible-roles</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-cockpit</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-copy-file-rsync</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-gnome-remote-desktop</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-networkmanager-nmcli</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-ntp-time-synchronization</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-predictable-naming</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-snapper-basics</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-subnet-manager</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-sudo-run-commands-as-superuser</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-supportconfig</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-systemd-basics</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="administration">
<dc>DC-SLES-systemd-timers</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<!--*************** container-virtualization ***************-->
<deliverable category="container-virtualization">
<dc>DC-SLES-apache-tomcat-cloud</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="container-virtualization">
<dc>DC-SLES-virtualization</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="container-virtualization">
<dc>DC-SLES-virtualization-disk-cache</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="container-virtualization">
<dc>DC-SLES-virtualization-io</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="container-virtualization">
<dc>DC-SLES-virtualization-libvirt</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="container-virtualization">
<dc>DC-SLES-virtualization-qemu</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="container-virtualization">
<dc>DC-SLES-virtualization-spice-removal</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="container-virtualization">
<dc>DC-SLES-virtualization-support</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="container-virtualization">
<dc>DC-SLES-vm-host-network-multihome-setup</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<!--****************** product-usage ******************-->
<deliverable category="product-usage">
<dc>DC-SLES-GNOME-getting-started</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="product-usage">
<dc>DC-SLES-valkey</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<!--*************** security-compliance ***************-->
<deliverable category="security-compliance">
<dc>DC-SLES-intro-firewalld</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="security-compliance">
<dc>DC-SLES-SELinux</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<deliverable category="security-compliance">
<dc>DC-SLES-sudo-configure-superuser-privileges</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
<!--*********tuning-performance******-->
<deliverable category="tuning-performance">
<dc>DC-SAP-saptune</dc>
<format html="1" pdf="1" single-html="0"/>
</deliverable>
</locale>

<locale lang="de-de">
<branch>main</branch>
<deliverable>
<dc>DC-foo</dc>
<format html="1"/>
</deliverable>
</locale>
</resources>

<external>
<link category="about" gated="false">
<url href="http://example.com" format="html"/>
<url href="http://example.com/doc.pdf" format="pdf"/>
<!-- Cardinality: + -->
<descriptions>
<desc lang="en-us">
<title> </title>
<p>...</p>
</desc>
<!-- more <desc> for other languages -->
</descriptions>
</link>
</external>
</docset>
Empty file.
20 changes: 20 additions & 0 deletions src/docbuild/config/xml/data/config.d/sles/desc/en-us.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-model href="../../../portal-config-schema.rnc" type="application/relax-ng-compact-syntax"?>
<desc lang="en-us">
<title>THE platform for your business-critical apps in any environment</title>
<p>
A multimodal operating system that paves the way for IT transformation in the
software-defined era.
</p>
<p>
The modern and modular OS helps simplify multimodal IT, makes traditional IT
infrastructure efficient and provides an engaging platform for developers.
As a result, you can easily deploy and transition business-critical workloads
across on-premise and public cloud environments.
</p>
<p>
SUSE Linux Enterprise Server, based on latest SUSE Linux Enterprise, is another
example of our open approach helping you optimize and modernize your multimodal
IT infrastructure.
</p>
</desc>
20 changes: 20 additions & 0 deletions src/docbuild/config/xml/data/config.d/sles/sles.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?xml-model href="file:../../portal-config-schema.rnc" type="application/relax-ng-compact-syntax"?>
<product id="sles" schemaversion="7.0" family="linux" series="pas"
xmlns:xi="http://www.w3.org/2001/XInclude">
<name>SUSE Linux Enterprise Server</name>
<acronym>SLES</acronym>
<maintainers>
<contact>[email protected]</contact>
<contact>[email protected]</contact>
<contact>[email protected]</contact>
</maintainers>

<descriptions>
<xi:include href="desc/en-us.xml" />
</descriptions>

<!-- docsets: -->
<xi:include href="16.0.xml" />
<!-- <xi:include href="docsets/15-SP7.xml"/> -->

</product>
Loading
Loading