|
89 | 89 | </tbody> |
90 | 90 | </tgroup> |
91 | 91 | </table> |
92 | | - <section xml:id="sec-revinfo"> |
93 | | - <title>Revision information</title> |
94 | | - <para>Every HTML file generated from our XML sources must include at least |
95 | | - one revision date. Revision dates signal content freshness to human |
96 | | - readers, search engines and LLMs.</para> |
97 | | - |
98 | | - <para>Every chapter, part or book that is included in our builds contains a |
99 | | - revision history. For product documentation up to SLE 15 SP7, this revision |
100 | | - history typically consists of a single revision entry with an empty |
101 | | - description. The revision date is updated in place every time |
102 | | - the content undergoes a significant change.</para> |
103 | | - |
104 | | - <para>Starting with SLE 16 releases, product documentation includes |
105 | | - a complete revision history with several dates and descriptions. |
106 | | - Follow the instructions in <xref linkend="sec-revhistory" />.</para> |
107 | | - |
108 | | - <para>To determine whether a change you made warrants a revision date, use this table:</para> |
109 | | - <informaltable> |
110 | | - <tgroup cols="2"> |
111 | | - <colspec colnum="1" colname="c1" colwidth="4.25*" /> |
112 | | - <colspec colnum="3" colname="c3" colwidth="1*" /> |
113 | | - <thead> |
114 | | - <row> |
115 | | - <entry>Change</entry> |
116 | | - <entry>Change revision date?</entry> |
117 | | - </row> |
118 | | - </thead> |
119 | | - <tbody> |
120 | | - <row> |
121 | | - <entry>Added a new feature or deleted an obsolete one</entry> |
122 | | - <entry>Yes</entry> |
123 | | - </row> |
124 | | - <row> |
125 | | - <entry>Fixed a broken link</entry> |
126 | | - <entry>Yes</entry> |
127 | | - </row> |
128 | | - <row> |
129 | | - <entry>Metadata fix (new description, change in product name and/or version, ...)</entry> |
130 | | - <entry>Yes</entry> |
131 | | - </row> |
132 | | - <row> |
133 | | - <entry>Typo and grammar fixes, editorial reviews</entry> |
134 | | - <entry>No</entry> |
135 | | - </row> |
136 | | - <row> |
137 | | - <entry>Formatting changes</entry> |
138 | | - <entry>No</entry> |
139 | | - </row> |
140 | | - </tbody> |
141 | | - </tgroup> |
142 | | - </informaltable> |
143 | | - <example xml:id="ex-revinfo-source"> |
144 | | - <title>Revision information example (source)</title> |
145 | | -<screen> |
146 | | -<revhistory xml:id="rh-use-rootid"> |
147 | | - <revision><date>YYYY-MM-DD</date> |
148 | | - <revdescription /> |
149 | | - </revision> |
150 | | -</revhistory></screen> |
151 | | - </example> |
152 | | - <example xml:id="ex-revinfo-output"> |
153 | | - <title>Revision history example (output)</title> |
154 | | - <revhistory xml:id="rh-use-rootid"> |
155 | | - <revision><date>2025-12-14</date> |
156 | | - <revdescription /> |
157 | | - </revision> |
158 | | - </revhistory> |
159 | | - </example> |
160 | | - </section> |
161 | 92 | <section xml:id="sec-admonition"> |
162 | 93 | <title>Admonitory and advisory paragraphs</title> |
163 | 94 | <para> |
@@ -3329,6 +3260,75 @@ There are less than 4 GB of space available on the selected partition.</screen> |
3329 | 3260 | <xref linkend="sec-cross-reference"/> and <xref linkend="sec-link"/>. |
3330 | 3261 | </para> |
3331 | 3262 | </section> |
| 3263 | + <section xml:id="sec-revinfo"> |
| 3264 | + <title>Revision information</title> |
| 3265 | + <para>Every HTML file generated from our XML sources must include at least |
| 3266 | + one revision date. Revision dates signal content freshness to human |
| 3267 | + readers, search engines and LLMs.</para> |
| 3268 | + |
| 3269 | + <para>Every chapter, part or book that is included in our builds contains a |
| 3270 | + revision history. For product documentation up to SLE 15 SP7, this revision |
| 3271 | + history typically consists of a single revision entry with an empty |
| 3272 | + description. The revision date is updated in place every time |
| 3273 | + the content undergoes a significant change.</para> |
| 3274 | + |
| 3275 | + <para>Starting with SLE 16 releases, product documentation includes |
| 3276 | + a complete revision history with several dates and descriptions. |
| 3277 | + Follow the instructions in <xref linkend="sec-revhistory" />.</para> |
| 3278 | + |
| 3279 | + <para>To determine whether a change you made warrants a revision date, use this table:</para> |
| 3280 | + <informaltable> |
| 3281 | + <tgroup cols="2"> |
| 3282 | + <colspec colnum="1" colname="c1" colwidth="4.25*" /> |
| 3283 | + <colspec colnum="3" colname="c3" colwidth="1*" /> |
| 3284 | + <thead> |
| 3285 | + <row> |
| 3286 | + <entry>Change</entry> |
| 3287 | + <entry>Change revision date?</entry> |
| 3288 | + </row> |
| 3289 | + </thead> |
| 3290 | + <tbody> |
| 3291 | + <row> |
| 3292 | + <entry>Added a new feature or deleted an obsolete one</entry> |
| 3293 | + <entry>Yes</entry> |
| 3294 | + </row> |
| 3295 | + <row> |
| 3296 | + <entry>Fixed a broken link</entry> |
| 3297 | + <entry>Yes</entry> |
| 3298 | + </row> |
| 3299 | + <row> |
| 3300 | + <entry>Metadata fix (new description, change in product name and/or version, ...)</entry> |
| 3301 | + <entry>Yes</entry> |
| 3302 | + </row> |
| 3303 | + <row> |
| 3304 | + <entry>Typo and grammar fixes, editorial reviews</entry> |
| 3305 | + <entry>No</entry> |
| 3306 | + </row> |
| 3307 | + <row> |
| 3308 | + <entry>Formatting changes</entry> |
| 3309 | + <entry>No</entry> |
| 3310 | + </row> |
| 3311 | + </tbody> |
| 3312 | + </tgroup> |
| 3313 | + </informaltable> |
| 3314 | + <example xml:id="ex-revinfo-source"> |
| 3315 | + <title>Revision information example (source)</title> |
| 3316 | +<screen> |
| 3317 | +<revhistory xml:id="rh-use-rootid"> |
| 3318 | + <revision><date>YYYY-MM-DD</date> |
| 3319 | + <revdescription /> |
| 3320 | + </revision> |
| 3321 | +</revhistory></screen> |
| 3322 | + </example> |
| 3323 | + <example xml:id="ex-revinfo-output"> |
| 3324 | + <title>Revision history example (output)</title> |
| 3325 | + <revhistory xml:id="rh-use-rootid"> |
| 3326 | + <revision><date>2025-12-14</date> |
| 3327 | + <revdescription /> |
| 3328 | + </revision> |
| 3329 | + </revhistory> |
| 3330 | + </example> |
| 3331 | + </section> |
3332 | 3332 | <section xml:id="sec-table"> |
3333 | 3333 | <title>Tables</title> |
3334 | 3334 | <para> |
|
0 commit comments