1 |
nightmorph 10/12/06 11:24:51 |
2 |
|
3 |
Modified: doc-tipsntricks.xml |
4 |
Log: |
5 |
update doc tips and tricks for new revbump policy |
6 |
|
7 |
Revision Changes Path |
8 |
1.28 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml |
9 |
|
10 |
file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.28&view=markup |
11 |
plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.28&content-type=text/plain |
12 |
diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?r1=1.27&r2=1.28 |
13 |
|
14 |
Index: doc-tipsntricks.xml |
15 |
=================================================================== |
16 |
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v |
17 |
retrieving revision 1.27 |
18 |
retrieving revision 1.28 |
19 |
diff -u -r1.27 -r1.28 |
20 |
--- doc-tipsntricks.xml 28 Apr 2010 19:26:07 -0000 1.27 |
21 |
+++ doc-tipsntricks.xml 6 Dec 2010 11:24:51 -0000 1.28 |
22 |
@@ -1,7 +1,7 @@ |
23 |
<?xml version='1.0' encoding="UTF-8"?> |
24 |
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
25 |
|
26 |
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.27 2010/04/28 19:26:07 nightmorph Exp $ --> |
27 |
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.28 2010/12/06 11:24:51 nightmorph Exp $ --> |
28 |
|
29 |
<guide> |
30 |
<title>Documentation Development Tips & Tricks</title> |
31 |
@@ -23,8 +23,8 @@ |
32 |
|
33 |
<license/> |
34 |
|
35 |
-<version>4</version> |
36 |
-<date>2010-04-28</date> |
37 |
+<version>5</version> |
38 |
+<date>2010-12-06</date> |
39 |
|
40 |
<chapter> |
41 |
<title>Checking out the web site files</title> |
42 |
@@ -346,8 +346,8 @@ |
43 |
|
44 |
<p> |
45 |
Conforming to the policy, you <e>must</e> bump a version/date when you make |
46 |
-certain changes (most actually). Although the version is less important (SwifT |
47 |
-will still kill you if you forget it) the date tells our users when the |
48 |
+certain changes (most actually). Although the version is less important (the GDP |
49 |
+lead will still kill you if you forget it) the date tells our users when the |
50 |
document was last modified. |
51 |
</p> |
52 |
|
53 |
@@ -364,11 +364,29 @@ |
54 |
its content. |
55 |
</p> |
56 |
|
57 |
+<!-- Since 2007 or so we've been moving toward simple whole numbers; |
58 |
+No need for complicated decimals |
59 |
<p> |
60 |
Another common mistake is to update the version number as if it were a decimal |
61 |
number. It's not. <c>3.9</c> should become <c>3.10</c>, not <c>4.0</c>, nor |
62 |
<c>3.91</c>. |
63 |
</p> |
64 |
+--> |
65 |
+ |
66 |
+<p> |
67 |
+Another common mistake is to update the version number using decimals. You |
68 |
+shouldn't do this. The version is a simple whole number. Each update should |
69 |
+increment it by one. <c>9</c> should become <c>10</c>, not <c>9.1</c>. For old |
70 |
+documents not yet using the simpler whole number versioning, please increment it |
71 |
+to the nearest whole number. So <c>4.67</c> should become <c>5</c>, <c>1.2</c> |
72 |
+should become <c>2</c>, and so on. |
73 |
+</p> |
74 |
+ |
75 |
+<impo> |
76 |
+The exception to this rule is <path>/doc/en/metadoc.xml</path>. Metadoc should |
77 |
+still use the existing point version scheme. So <c>1.119</c> becomes <c>1.120</c>, not |
78 |
+<c>1.12</c>. |
79 |
+</impo> |
80 |
|
81 |
</body> |
82 |
</section> |