Assembly basics done

SUSE · Aug 1, 2023 · 4cbd904 · 4cbd904
1 parent 7bfd362
commit 4cbd904
Show file tree

Hide file tree

Showing 2 changed files with 149 additions and 0 deletions.
diff --git a/DC-network-interface-predictable-naming b/DC-network-interface-predictable-naming
@@ -0,0 +1,18 @@
+# This file originates from the project https://github.com/openSUSE/doc-kit
+# This file can be edited downstream.
+
+MAIN="network-interface-predictable-naming.asm.xml"
+# Point to the ID of the <structure> of your assembly
+ROOTID="network-interface-predictable-naming"
+SRC_DIR="articles"
+IMG_SRC_DIR="images"
+
+PROFCONDITION="suse-product"
+#PROFCONDITION="suse-product;beta"
+#PROFCONDITION="community-project"
+
+# Just a test:
+STYLEASSEMBLY="/usr/share/xml/docbook/stylesheet/nwalsh5/current/assembly/assemble.xsl"
+
+STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
+FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"
diff --git a/articles/network-interface-predictable-naming.asm.xml b/articles/network-interface-predictable-naming.asm.xml
@@ -0,0 +1,131 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- file: templates/articles/assembly.xml -->
+<?xml-model href="https://cdn.docbook.org/schema/5.2/rng/assemblyxi.rnc"
+            type="application/relax-ng-compact-syntax"?>
+<!DOCTYPE assembly
+[
+    <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+    %entities;
+]>
+<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
+<!-- point back to this document with a similar comment added to your legacy doc piece -->
+<!-- refer to README.md for file and id naming conventions -->
+<assembly version="5.2" xml:lang="en"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:trans="http://docbook.org/ns/transclusion"
+          xmlns:its="http://www.w3.org/2005/11/its"
+          xmlns="http://docbook.org/ns/docbook">
+  <!-- resources section references all topic chunks used in the final article
+    -->
+  <!-- R E S O U R C E S -->
+  <!-- Concept files -->
+  <resources>
+    <resource xml:id="_concept-example" href="../concepts/network-interface-predictable-naming.xml">
+      <description>Concept example</description>
+    </resource>
+    <resource href="../common/legal.xml" xml:id="_legal">
+      <description>Legal Notice</description>
+    </resource>
+    <resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl">
+      <description>GNU Free Documentation License</description>
+    </resource>
+  </resources>
+  <!-- S T R U C T U R E -->
+  <structure renderas="article" xml:id="network-interface-predictable-naming" xml:lang="en">
+    <merge>
+      <title>Predictable naming of network interface</title>
+      <revhistory>
+        <title>Changelog</title>
+        <revision><date>2023-06-31</date>
+          <revdescription>
+            <para>
+              Initial version
+            </para>
+          </revdescription>
+        </revision>
+      </revhistory>
+      <meta name="maintainer" content="[email protected]" its:translate="no"/>
+      <!-- ISO date of last update as YYYY-MM-DD -->
+      <meta name="updated" content="2023-11-11" its:translate="no"/>
+      <!-- this does not work yet. Use the dm tags listed below for now
+        <meta name="bugtracker" its:translate="no">
+        <phrase role="url">https://bugzilla.suse.com/enter_bug.cgi</phrase>
+        <phrase role="component">Non-product-specific documentation</phrase>
+        <phrase role="product">Smart Docs</phrase>
+        <phrase role="assignee">[email protected]</phrase>
+        </meta>
+        -->
+      <!-- not supported, yet. Use dm: tag for now
+        <meta name="translation" its:translate="no">
+        <phrase role="trans">yes</phrase>
+        <phrase role="language">de-de,cs-cz</phrase>
+        </meta>
+        -->
+      <!-- enter the platform identifier or a list of
+        identifiers, separated by ; -->
+      <meta name="architecture" content="x86;power" its:translate="no"/>
+      <meta name="productname" its:translate="no">
+        <!-- enter product name and version --><productname version="15-SP5">&sles;</productname>
+      </meta>
+      <meta name="title" its:translate="yes">Predictable network interface naming</meta>
+      <meta name="description" its:translate="yes">By using predictable naming
+      scheme, the system automatically provides persistent names for network
+      interfaces that are stable across reboots or hardware changes.</meta>
+      <meta name="social-descr" its:translate="yes">Predictable network
+      interface naming ensures stable names across system reboots or hardware changes.</meta>
+      <!-- suitable category, comma-separated list of categories -->
+      <meta name="category" content="Systems Management" its:translate="no"/>
+      <dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
+        <dm:bugtracker>
+          <dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
+          <dm:component>Smart Docs</dm:component>
+          <dm:product>Documentation</dm:product>
+          <dm:assignee>[email protected]</dm:assignee>
+        </dm:bugtracker>
+        <dm:translation>yes</dm:translation>
+      </dm:docmanager>
+      <abstract>
+        <variablelist>
+          <varlistentry>
+            <term>TOPIC</term>
+            <listitem>
+              <para>
+                Predictable network interface naming provides stable and
+                persistent names to system network interfaces. Such names
+                survive system reboots and hardware changes.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>INTENTION</term>
+            <listitem>
+              <para>
+                You can learn how to activate and deactivate the predictable
+                network interface naming scheme on your system.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>EFFORT</term>
+            <listitem>
+              <para>
+                It takes 10 minutes to read and understand how to activate the
+                predictable naming scheme to network interfaces on your system.
+              </para>
+            </listitem>
+          </varlistentry>
+        </variablelist>
+      </abstract>
+    </merge>
+    <!-- pull in all the topic files you need -->
+    <!-- pick the appropriate type of include to match your needs -->
+    <!-- pull in a topic as is -->
+    <module resourceref="_glue-example" renderas="section"/>
+    <!-- pull in a topic and switch the title -->
+    <module resourceref="_concept-example" renderas="section"/>
+    <module resourceref="_legal"/>
+    <module resourceref="_gfdl">
+      <output renderas="appendix"/>
+    </module>
+  </structure>
+</assembly>