Author: dennisl
Date: Thu Jun 26 12:43:40 2008
New Revision: 672009
URL: http://svn.apache.org/viewvc?rev=672009&view=rev
Log:
o Initial version of the guide to Maven Documentation Style.
Added:
maven/site/trunk/src/site/apt/guides/development/guide-documentation-style.apt
(with props)
Modified:
maven/site/trunk/src/site/apt/guides/index.apt
Added:
maven/site/trunk/src/site/apt/guides/development/guide-documentation-style.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/development/guide-documentation-style.apt?rev=672009&view=auto
==============================================================================
---
maven/site/trunk/src/site/apt/guides/development/guide-documentation-style.apt
(added)
+++
maven/site/trunk/src/site/apt/guides/development/guide-documentation-style.apt
Thu Jun 26 12:43:40 2008
@@ -0,0 +1,47 @@
+ ------
+ Guide To Maven Documentation Style
+ ------
+ Dennis Lundberg
+ ------
+ 2008-06-26
+ ------
+
+Guide To Maven Documentation Style
+
+
+* Where did the style came from?
+
+ The documentation style guide was created to make our documentation more
+ consistent and also to apply best practices to the documentation as well.
+ The standard has just been started and will expand over time based on the
+ suggestions made on the Maven dev mailing list. It is a community consensus
+ of how we should write our documentation.
+
+ Each rule in this guide should come with a motivation as to why it exists.
+ References to external sources are encouraged.
+
+
+* Date format
+
+ How people format a date varies around the world, sometimes making it hard
+ for people to understand each other. The solution to this problem comes in
+ the form of the ISO-8601 standard.
+
+ A date in our documentation must follow this standard:
+
+ <<YYYY-MM-DD>>
+
+ where <<YYYY>> is the year in the Gregorian calendar, <<MM>> is the month of
+ the year between 01 (January) and 12 (December), and <<DD>> is the day of the
+ month between 01 and 31.
+
+** References
+
+ * {{{http://www.w3.org/QA/Tips/iso-date}W3C Quality Web Tips}}
+
+ *
{{{http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=26780}ISO-8601}}
+
+ []
+
+
+~~ NOTE: Add more rules here. Follow the heading style of the rule above.
Propchange:
maven/site/trunk/src/site/apt/guides/development/guide-documentation-style.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/site/trunk/src/site/apt/guides/development/guide-documentation-style.apt
------------------------------------------------------------------------------
svn:keywords = Date Revision Author Id
Modified: maven/site/trunk/src/site/apt/guides/index.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/index.apt?rev=672009&r1=672008&r2=672009&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/guides/index.apt (original)
+++ maven/site/trunk/src/site/apt/guides/index.apt Thu Jun 26 12:43:40 2008
@@ -140,6 +140,8 @@
* {{{./development/guide-plugin-documentation.html}The Plugin Documentation
Standard}}
+ * {{{./development/guide-documentation-style.html}Maven Documentation Style}}
+
* The Maven Community
