diff --git a/xml/docu_styleguide.smartdocs.xml b/xml/docu_styleguide.smartdocs.xml index fe37749..ddbe21e 100644 --- a/xml/docu_styleguide.smartdocs.xml +++ b/xml/docu_styleguide.smartdocs.xml @@ -335,7 +335,7 @@ ultrashort description for social media, max. 55 chars</meta> <merge> <title>Your title, limit to 55 characters, if possible</title> <subtitle>Subtitle if necessary</subtitle> - <revhistory xml:id="rh-USE_ROOTID"> + <revhistory xml:id="rh-USE-ROOTID"> <revision> <date>2024-11-11</date> <revdescription> @@ -390,7 +390,7 @@ ultrashort description for social media, max. 55 chars</meta> Update revision history regularly, mentioning most important changes to your document when you amend or rework it. The data you enter as revision - history is used as meta data. The Revision History text is + history is used as metadata. The Revision history text is available as a link before the abstract and opens up in its individual page. Keep in mind the following rules: @@ -409,7 +409,7 @@ ultrashort description for social media, max. 55 chars</meta> If you have several changes of the same type (addition, change, - removal), group them under a dedicated + removal), you may group them under a dedicated itemizedlist. @@ -426,28 +426,15 @@ ultrashort description for social media, max. 55 chars</meta> Revision history example (source) <revhistory xml:id="rh-USE-ROOTID"> - <revision><date>2024-11-13</date> + <revision><date>YYYY-MM-DD</date> <revdescription> - <itemizedlist> - <listitem><para>Added sections:</para> - <itemizedlist> - <listitem><para>New section on <quote>foo</quote> to resolve issue <uri>bsc#12345</uri></para></listitem> - <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> + <para>Updated CONTENT, extended CONTENT, removed CONTENT</para> + </revdescription> + </revision> + <revision><date>YYYY-MM-DD</date> + <revdescription> + <para>Updated for the initial release of <phrase role="productname">SUSE Linux Enterprise Server</phrase> + <phrase role="productnumber">15 SP6</phrase></para> </revdescription> </revision> </revhistory> @@ -457,62 +444,13 @@ ultrashort description for social media, max. 55 chars</meta> 2024-11-13 - - - - Added sections: - - - - - New section on foo to resolve issue - bsc#12345 - - - - - New section on foo bar - - - - - - - Removed sections: - - - - - Removed section on foo1 to resolve issue - bsc#12346 - - - - - Removed section on foo1 bar - - - - - - - Changed sections: - - - - - Changed section on foo2 to resolve issue - bsc#12347 - - - - - Changed section on foo2 bar - - - - - + Updated chapter on foo bar, removed section on foo bar 1 + + + 2024-09-21 + + Updated for the initial release of SUSE Linux Enterprise Server + 15 SP6