krb5 commit: Revise philosopy.rst and fix doc typo
Zhanna A Tsitkova
tsitkova at MIT.EDU
Wed Jul 18 11:37:43 EDT 2012
https://github.com/krb5/krb5/commit/177e9e3f65e784081a006e28a00b425118845549
commit 177e9e3f65e784081a006e28a00b425118845549
Author: Zhanna Tsitkov <tsitkova at mit.edu>
Date: Wed Jul 18 11:45:18 2012 -0400
Revise philosopy.rst and fix doc typo
doc/rst_source/krb_basic/date_format.rst | 2 +-
doc/rst_source/relay/philosophy.rst | 36 +++++++----------------------
2 files changed, 10 insertions(+), 28 deletions(-)
diff --git a/doc/rst_source/krb_basic/date_format.rst b/doc/rst_source/krb_basic/date_format.rst
index d2ab7b9..a5a2ce2 100644
--- a/doc/rst_source/krb_basic/date_format.rst
+++ b/doc/rst_source/krb_basic/date_format.rst
@@ -126,7 +126,7 @@ Abbreviations used in this document
| *N* : number;
| *pp* : AM or PM;
| *ss* : seconds (00-60);
-| *tt* : time units (houris, minutes, min, seconds, sec);
+| *tt* : time units (hours, minutes, min, seconds, sec);
| *yyyy* : year;
| *yy* : last two digits of the year;
| *Z* : alphabetic time zone abbreviation;
diff --git a/doc/rst_source/relay/philosophy.rst b/doc/rst_source/relay/philosophy.rst
index e4f32f6..2771f84 100644
--- a/doc/rst_source/relay/philosophy.rst
+++ b/doc/rst_source/relay/philosophy.rst
@@ -4,43 +4,25 @@ Kerberos Documentation Relay
Philosophy
----------
-#. The documentation must be useful;
+- The documentation must be useful;
-#. The documentation must be correct;
+- The documentation must be correct;
-#. The documentation must be detailed, but optimized. No verbose mode;
+- The documentation must be detailed, but optimized. No verbose mode;
-#. The documentation should be built incrementally;
+- The documentation should be built incrementally;
-#. The documentation should be easy to maintain;
+- The documentation should be easy to maintain;
-#. The documentation should be examined to identify the approaches
+- The documentation should be examined to identify the approaches
that do not work;
-
-Process
--------
-
-#. The Work-To-Do list is created and updated based on the input from
- the community.
-#. Administrator supports the Work-To-Do list.
-#. Writer picks up the item from this list (such as specific API) and
- writes the documentation
-#. Committee reviews the documentation and recommends it to be
- accepted as-is or to be revised
-#. If the documentation needs revision, it is sent to the initial
- writer or someone else for completion
-#. Once Committee approves the document, it is proofread by the
- designated engineer
-#. Documented is posted on the web
-
-
Feedback and Comments
---------------------
At the moment the comments should be sent via email to
krb5-bugs at mit.edu.
-The html version of this documentation has a "feedback" link
-(within the sidebar) to the krb5-bugs at mit.edu email address
-with the pre-constructed subject line "Documentation".
+The html version of this documentation has a "FEEDBACK" link
+(at the bottom of every page) to the krb5-bugs at mit.edu email address
+with the pre-constructed subject line.
More information about the cvs-krb5
mailing list