diff options
author | Zhanna Tsitkov <tsitkova@mit.edu> | 2012-07-18 11:45:18 -0400 |
---|---|---|
committer | Zhanna Tsitkov <tsitkova@mit.edu> | 2012-07-18 11:50:32 -0400 |
commit | 177e9e3f65e784081a006e28a00b425118845549 (patch) | |
tree | 49cb5302cf3d2920e3234b8366dca389195d8395 /doc/rst_source | |
parent | 2d1bb573022e5eb5c84d2dc2d1585eeff46e9faa (diff) | |
download | krb5-177e9e3f65e784081a006e28a00b425118845549.tar.gz krb5-177e9e3f65e784081a006e28a00b425118845549.tar.xz krb5-177e9e3f65e784081a006e28a00b425118845549.zip |
Revise philosopy.rst and fix doc typo
Diffstat (limited to 'doc/rst_source')
-rw-r--r-- | doc/rst_source/krb_basic/date_format.rst | 2 | ||||
-rw-r--r-- | 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 d2ab7b9820..a5a2ce2332 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 e4f32f6146..2771f84a86 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@mit.edu. -The html version of this documentation has a "feedback" link -(within the sidebar) to the krb5-bugs@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@mit.edu email address +with the pre-constructed subject line. |