* [gentoo-commits] gentoo commit in xml/htdocs/proj/en/gdp/doc: doc-tipsntricks.xml
@ 2010-04-28 18:21 Joshua Saddler (nightmorph)
0 siblings, 0 replies; 5+ messages in thread
From: Joshua Saddler (nightmorph) @ 2010-04-28 18:21 UTC (permalink / raw
To: gentoo-commits
nightmorph 10/04/28 18:21:52
Modified: doc-tipsntricks.xml
Log:
Removed references to neysx.org, bug 317609
Revision Changes Path
1.26 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.26&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.26&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?r1=1.25&r2=1.26
Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- doc-tipsntricks.xml 17 Jul 2007 17:57:25 -0000 1.25
+++ doc-tipsntricks.xml 28 Apr 2010 18:21:51 -0000 1.26
@@ -1,16 +1,19 @@
<?xml version='1.0' encoding="UTF-8"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.25 2007/07/17 17:57:25 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.26 2010/04/28 18:21:51 nightmorph Exp $ -->
-<guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
+<guide>
<title>Documentation Development Tips & Tricks</title>
<author title="Author">
- <mail link="neysx@gentoo.org">Xavier Neys</mail>
+ <mail link="neysx"/>
</author>
<author title="Author">
- <mail link="swift@gentoo.org">Sven Vermeulen</mail>
+ <mail link="swift"/>
+</author>
+<author title="Editor">
+ <mail link="nightmorph"/>
</author>
<abstract>
@@ -20,8 +23,8 @@
<license/>
-<version>2</version>
-<date>2007-03-08</date>
+<version>3</version>
+<date>2010-04-28</date>
<chapter>
<title>Checking out the web site files</title>
@@ -93,9 +96,8 @@
<body>
<p>
-Our GuideXML documentation is transformed into HTML by the <uri
-link="http://gentoo.neysx.org/mystuff/gorg/gorg.xml">www-servers/gorg</uri>
-package. You need to install it.
+Our GuideXML documentation is transformed into HTML by the
+<c>www-servers/gorg</c> package. You need to install it.
</p>
<note>
@@ -104,11 +106,9 @@
</note>
<p>
-Follow the directions on <uri
-link="http://gentoo.neysx.org/mystuff/gorg/gorg.xml">gorg's home page</uri> to
-configure it. You need to define the web root directory where you checked out
-our CVS repository (<path>.../gentoo/xml/htdocs</path>). The other parameters
-are only useful if you want to serve a local copy of <uri
+Once <c>gorg</c> is installed, you need to define the web root directory where
+you checked out our CVS repository (<path>.../gentoo/xml/htdocs</path>). The
+other parameters are only useful if you want to serve a local copy of <uri
link="http://www.gentoo.org">www.gentoo.org</uri>.
</p>
@@ -199,9 +199,8 @@
<p>
Since you checked out a copy of Gentoo's web site out of our CVS, you can also
-use gorg to browse your local copy. Make sure you download the news index as
-explained on <uri link="http://gentoo.neysx.org/mystuff/gorg/gorg.xml">gorg's
-home page</uri> if you want to see the same front page.
+use gorg to browse your local copy. Make sure you download the news index if you
+want to see the same front page.
</p>
</body>
^ permalink raw reply [flat|nested] 5+ messages in thread
* [gentoo-commits] gentoo commit in xml/htdocs/proj/en/gdp/doc: doc-tipsntricks.xml
@ 2010-04-28 19:26 Joshua Saddler (nightmorph)
0 siblings, 0 replies; 5+ messages in thread
From: Joshua Saddler (nightmorph) @ 2010-04-28 19:26 UTC (permalink / raw
To: gentoo-commits
nightmorph 10/04/28 19:26:08
Modified: doc-tipsntricks.xml
Log:
Readded gorg info now that I XMLified it and put it on gentoo.org
Revision Changes Path
1.27 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.27&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.27&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?r1=1.26&r2=1.27
Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -r1.26 -r1.27
--- doc-tipsntricks.xml 28 Apr 2010 18:21:51 -0000 1.26
+++ doc-tipsntricks.xml 28 Apr 2010 19:26:07 -0000 1.27
@@ -1,7 +1,7 @@
<?xml version='1.0' encoding="UTF-8"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.26 2010/04/28 18:21:51 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.27 2010/04/28 19:26:07 nightmorph Exp $ -->
<guide>
<title>Documentation Development Tips & Tricks</title>
@@ -23,7 +23,7 @@
<license/>
-<version>3</version>
+<version>4</version>
<date>2010-04-28</date>
<chapter>
@@ -97,7 +97,7 @@
<p>
Our GuideXML documentation is transformed into HTML by the
-<c>www-servers/gorg</c> package. You need to install it.
+<uri link="gorg.xml">www-servers/gorg</uri> package. You need to install it.
</p>
<note>
@@ -106,9 +106,10 @@
</note>
<p>
-Once <c>gorg</c> is installed, you need to define the web root directory where
-you checked out our CVS repository (<path>.../gentoo/xml/htdocs</path>). The
-other parameters are only useful if you want to serve a local copy of <uri
+Follow the <uri link="gorg.xml">directions</uri> to configure gorg. You need to
+define the web root directory where you checked out our CVS repository
+(<path>.../gentoo/xml/htdocs</path>). The other parameters are only useful if
+you want to serve a local copy of <uri
link="http://www.gentoo.org">www.gentoo.org</uri>.
</p>
@@ -199,8 +200,9 @@
<p>
Since you checked out a copy of Gentoo's web site out of our CVS, you can also
-use gorg to browse your local copy. Make sure you download the news index if you
-want to see the same front page.
+use gorg to browse your local copy. Make sure you download the news index as
+explained <uri link="gorg.xml">in the guide</uri> if you want to see the same
+front page.
</p>
</body>
^ permalink raw reply [flat|nested] 5+ messages in thread
* [gentoo-commits] gentoo commit in xml/htdocs/proj/en/gdp/doc: doc-tipsntricks.xml
@ 2010-12-06 11:24 Joshua Saddler (nightmorph)
0 siblings, 0 replies; 5+ messages in thread
From: Joshua Saddler (nightmorph) @ 2010-12-06 11:24 UTC (permalink / raw
To: gentoo-commits
nightmorph 10/12/06 11:24:51
Modified: doc-tipsntricks.xml
Log:
update doc tips and tricks for new revbump policy
Revision Changes Path
1.28 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml
file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.28&view=markup
plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.28&content-type=text/plain
diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?r1=1.27&r2=1.28
Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- doc-tipsntricks.xml 28 Apr 2010 19:26:07 -0000 1.27
+++ doc-tipsntricks.xml 6 Dec 2010 11:24:51 -0000 1.28
@@ -1,7 +1,7 @@
<?xml version='1.0' encoding="UTF-8"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.27 2010/04/28 19:26:07 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.28 2010/12/06 11:24:51 nightmorph Exp $ -->
<guide>
<title>Documentation Development Tips & Tricks</title>
@@ -23,8 +23,8 @@
<license/>
-<version>4</version>
-<date>2010-04-28</date>
+<version>5</version>
+<date>2010-12-06</date>
<chapter>
<title>Checking out the web site files</title>
@@ -346,8 +346,8 @@
<p>
Conforming to the policy, you <e>must</e> bump a version/date when you make
-certain changes (most actually). Although the version is less important (SwifT
-will still kill you if you forget it) the date tells our users when the
+certain changes (most actually). Although the version is less important (the GDP
+lead will still kill you if you forget it) the date tells our users when the
document was last modified.
</p>
@@ -364,11 +364,29 @@
its content.
</p>
+<!-- Since 2007 or so we've been moving toward simple whole numbers;
+No need for complicated decimals
<p>
Another common mistake is to update the version number as if it were a decimal
number. It's not. <c>3.9</c> should become <c>3.10</c>, not <c>4.0</c>, nor
<c>3.91</c>.
</p>
+-->
+
+<p>
+Another common mistake is to update the version number using decimals. You
+shouldn't do this. The version is a simple whole number. Each update should
+increment it by one. <c>9</c> should become <c>10</c>, not <c>9.1</c>. For old
+documents not yet using the simpler whole number versioning, please increment it
+to the nearest whole number. So <c>4.67</c> should become <c>5</c>, <c>1.2</c>
+should become <c>2</c>, and so on.
+</p>
+
+<impo>
+The exception to this rule is <path>/doc/en/metadoc.xml</path>. Metadoc should
+still use the existing point version scheme. So <c>1.119</c> becomes <c>1.120</c>, not
+<c>1.12</c>.
+</impo>
</body>
</section>
^ permalink raw reply [flat|nested] 5+ messages in thread
* [gentoo-commits] gentoo commit in xml/htdocs/proj/en/gdp/doc: doc-tipsntricks.xml
@ 2010-12-06 11:32 Joshua Saddler (nightmorph)
0 siblings, 0 replies; 5+ messages in thread
From: Joshua Saddler (nightmorph) @ 2010-12-06 11:32 UTC (permalink / raw
To: gentoo-commits
nightmorph 10/12/06 11:32:29
Modified: doc-tipsntricks.xml
Log:
clarify commit policy
Revision Changes Path
1.29 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml
file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.29&view=markup
plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.29&content-type=text/plain
diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?r1=1.28&r2=1.29
Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- doc-tipsntricks.xml 6 Dec 2010 11:24:51 -0000 1.28
+++ doc-tipsntricks.xml 6 Dec 2010 11:32:29 -0000 1.29
@@ -1,7 +1,7 @@
<?xml version='1.0' encoding="UTF-8"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.28 2010/12/06 11:24:51 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.29 2010/12/06 11:32:29 nightmorph Exp $ -->
<guide>
<title>Documentation Development Tips & Tricks</title>
@@ -23,7 +23,7 @@
<license/>
-<version>5</version>
+<version>6</version>
<date>2010-12-06</date>
<chapter>
@@ -377,9 +377,10 @@
Another common mistake is to update the version number using decimals. You
shouldn't do this. The version is a simple whole number. Each update should
increment it by one. <c>9</c> should become <c>10</c>, not <c>9.1</c>. For old
-documents not yet using the simpler whole number versioning, please increment it
-to the nearest whole number. So <c>4.67</c> should become <c>5</c>, <c>1.2</c>
-should become <c>2</c>, and so on.
+documents not yet using the simpler whole number versioning, please increment
+it to the nearest whole number the next time you make a commit to it. So
+<c>4.67</c> should become <c>5</c>, <c>1.2</c> should become <c>2</c>, and so
+on.
</p>
<impo>
^ permalink raw reply [flat|nested] 5+ messages in thread
* [gentoo-commits] gentoo commit in xml/htdocs/proj/en/gdp/doc: doc-tipsntricks.xml
@ 2010-12-06 12:07 Joshua Saddler (nightmorph)
0 siblings, 0 replies; 5+ messages in thread
From: Joshua Saddler (nightmorph) @ 2010-12-06 12:07 UTC (permalink / raw
To: gentoo-commits
nightmorph 10/12/06 12:07:01
Modified: doc-tipsntricks.xml
Log:
typo fix, spotted by jkt on the ML
Revision Changes Path
1.30 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml
file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.30&view=markup
plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.30&content-type=text/plain
diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?r1=1.29&r2=1.30
Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
--- doc-tipsntricks.xml 6 Dec 2010 11:32:29 -0000 1.29
+++ doc-tipsntricks.xml 6 Dec 2010 12:07:01 -0000 1.30
@@ -1,7 +1,7 @@
<?xml version='1.0' encoding="UTF-8"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.29 2010/12/06 11:32:29 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.30 2010/12/06 12:07:01 nightmorph Exp $ -->
<guide>
<title>Documentation Development Tips & Tricks</title>
@@ -385,8 +385,8 @@
<impo>
The exception to this rule is <path>/doc/en/metadoc.xml</path>. Metadoc should
-still use the existing point version scheme. So <c>1.119</c> becomes <c>1.120</c>, not
-<c>1.12</c>.
+still use the existing point version scheme. So <c>1.119</c> becomes
+<c>1.120</c>, not <c>2</c>.
</impo>
</body>
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2010-12-06 12:07 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2010-04-28 18:21 [gentoo-commits] gentoo commit in xml/htdocs/proj/en/gdp/doc: doc-tipsntricks.xml Joshua Saddler (nightmorph)
-- strict thread matches above, loose matches on Subject: below --
2010-04-28 19:26 Joshua Saddler (nightmorph)
2010-12-06 11:24 Joshua Saddler (nightmorph)
2010-12-06 11:32 Joshua Saddler (nightmorph)
2010-12-06 12:07 Joshua Saddler (nightmorph)
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox