doc-kit run

SUSE · Nov 30, 2023 · c57a461 · c57a461
1 parent a2f6618
commit c57a461
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 61 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,45 +10,3 @@ build/
 .idea/
 *.code-workspace
 .vimrc
-.editorconfig
-doc-kit.conf
-
-# docbook5
-xml/generic-entities.ent
-xml/network-entities.ent
-xml/common_intro_available_doc.xml
-xml/common_intro_support.xml
-xml/common_intro_convention.xml
-xml/common_intro_feedback.xml
-xml/common_copyright_gfdl.xml
-xml/common_legal.xml
-xml/common_license_gfdl1.2.xml
-xml/common_copyright_cc.xml
-
-# ascidoc
-.gitlab-ci.yml
-adoc_postprocess.xsl
-LICENSE
-Makefile
-adoc/about-documentation.adoc
-adoc/about-rn.adoc
-adoc/abstract.adoc
-adoc/attributes-generic.adoc
-adoc/legal.adoc
-adoc/source-code.adoc
-
-# smartdocs
-templates/_DC-article
-templates/articles/assembly.asm.xml
-templates/concepts/concept.xml
-templates/glues/glue-more-info.xml
-templates/glues/glue-whats-next.xml
-templates/glues/glue.xml
-templates/images/example.png
-templates/references/reference.xml
-templates/snippets/snippet_warning.xml
-templates/tasks/task.xml
-common/generic-entities.ent
-common/network-entities.ent
-common/legal.xml
-common/license_gfdl1.2.xml
diff --git a/common/legal.xml b/common/legal.xml
@@ -3,8 +3,8 @@
 <!-- DO NOT EDIT THIS FILE DOWNSTREAM. IT MAY BE OVERWRITTEN BY AN UPDATE. -->
 <!DOCTYPE topic
 [
-  <!ENTITY % entities SYSTEM "generic-entities.ent">
-    %entities;
+   <!ENTITY % entities SYSTEM "generic-entities.ent"> 
+   %entities; 
 ]>
 <topic xml:id="legal-disclaimer"
   xmlns="http://docbook.org/ns/docbook"

diff --git a/doc-kit.conf b/doc-kit.conf
@@ -1,10 +1,10 @@
 type: smart-doc
 variant: license-gfdl
 
-file: dc2d59d387d389305538e110c202353c782c4124  .gitignore
+file: d5aba8356449342d0bac0a62116b85f1b44ee73d  .gitignore
 file: c6b4745307e90c9b88905b434cbbaddc54e4541b  .editorconfig
 file: fd387aa507bd38e35a5a524648dfaf9ef57a5f87  templates/_DC-article
-file: 3ff9b2a2b8fb7953ff5f465f3c13ab8d9b6d57a5  templates/articles/assembly.asm.xml
+file: bc78a77c839cd064a4edb5bebf9c849ad0648102  templates/articles/assembly.asm.xml
 file: fb87ee8ade4dd3ffbf98ed5fcb68126c92e4b05a  templates/concepts/concept.xml
 file: b592f1720c4274da56232e084445f4e8be42e745  templates/glues/glue-more-info.xml
 file: afcf53442791e272593e8e669b73affc52499c4b  templates/glues/glue-whats-next.xml
@@ -15,5 +15,5 @@ file: ccd4111fb11fe4fa272d565d22872dda991d48f7  templates/snippets/snippet_warni
 file: bc33a5462e82871906d98907a32d9e28d558dfaa  templates/tasks/task.xml
 file: cf325df7010a5921d5404a6d942be6941a3508e1  common/generic-entities.ent
 file: a79a3bc929478668955564bab48aecc8502555f6  common/network-entities.ent
-file: c62522c02a5103b75e98467e3737786f8e5d6517  common/legal.xml
+file: fa8b6e68b9a1741ba98b97ee064a72acfb4f03ca  common/legal.xml
 file: c65de8676ad7ed0b6e86058da8ca538a4ac25b5d  common/license_gfdl1.2.xml
diff --git a/templates/articles/assembly.asm.xml b/templates/articles/assembly.asm.xml
@@ -61,28 +61,43 @@
     <merge>
       <title>Your title, limit to 55 characters, if possible</title>
       <subtitle>Subtitle if necessary</subtitle>
-      <!-- Create changelog to enable versioning; add most recent entries at the top. -->
-      <revhistory xml:id="rh-USE_ROOT_ID">
-        <revision><revnumber>2</revnumber><date>2024-11-11</date>
+      <!-- Create revision history to enable versioning; add most recent entries at the top. -->
+      <!-- Check https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-revhistory for detailed instructions-->
+      <revhistory xml:id="rh-USE-ROOT-ID">
+        <revision><date>2054-11-14</date>
           <revdescription>
-            <para>
-              Describe the purpose of this revision
-            </para>
-          </revdescription>
-        </revision>
-        <revision><revnumber>1</revnumber><date>2024-10-10</date>
-          <revdescription>
-            <para>
-              Describe the purpose of this revision
-            </para>
+            <itemizedlist>
+              <!-- Group by type of change (added/removed/changed)-->
+              <listitem><para>Added sections:</para>
+                <itemizedlist>
+                <!-- Reference, but don't link to tracker items-->
+                <!-- Follow https://en.opensuse.org/openSUSE:Packaging_Patches_guidelines#Current_set_of_abbreviations for tracker item references-->
+                  <listitem><para>New section on <quote>foo</quote> to resolve issue <uri>bsc#12345</uri></para></listitem>
+                  <!-- Name sections, but don't insert links -->
+                  <listitem><para>New section on <quote>foo bar</quote></para></listitem>
+                </itemizedlist>
+              </listitem>
+              <listitem><para>Removed sections:</para>
+                <itemizedlist>
+                  <listitem><para>Removed section on <quote>foo1</quote> to resolve issue <uri>bsc#12346</uri></para></listitem>
+                  <listitem><para>Removed section on <quote>foo1 bar</quote></para></listitem>
+                </itemizedlist>
+              </listitem>
+              <listitem><para>Changed sections:</para>
+                <itemizedlist>
+                  <listitem><para>Changed section on <quote>foo2</quote> to resolve issue <uri>bsc#12347</uri></para></listitem>
+                  <listitem><para>Changed section on <quote>foo2 bar</quote></para></listitem>
+                </itemizedlist>
+              </listitem>
+            </itemizedlist>
           </revdescription>
         </revision>
       </revhistory>
       <!-- TODO: provide a listing of possible and validatable meta entry values. Maybe in our geekodoc repo? -->
       <!-- add author's e-mail -->
       <meta name="maintainer" content="" its:translate="no"/>
       <!-- ISO date of last update as YYYY-MM-DD -->
-      <meta name="updated" content="2023-11-11" its:translate="no"/>
+      <meta name="updated" content="2037-11-16" 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>
@@ -99,6 +114,9 @@
         -->
       <!-- enter the platform identifier or a list of
         identifiers, separated by ; -->
+      <!-- For a full list of meta tags and their values,
+	   see https://confluence.suse.com/x/aQDWNg
+      -->
       <meta name="architecture" content="x86;power" its:translate="no"/>
       <meta name="productname" its:translate="no">
         <!-- enter product name and version --><productname version="X.Y">&productname;</productname>