Skip to content

Commit

Permalink
Revise philosopy.rst and fix doc typo
Browse files Browse the repository at this point in the history
  • Loading branch information
tsitkov committed Jul 18, 2012
1 parent 2d1bb57 commit 177e9e3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 28 deletions.
2 changes: 1 addition & 1 deletion doc/rst_source/krb_basic/date_format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
36 changes: 9 additions & 27 deletions doc/rst_source/relay/philosophy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 177e9e3

Please sign in to comment.