summaryrefslogtreecommitdiffstats
path: root/doc/rst_source/relay/index.rst
blob: 3a0e219f93d21f717f0ec4424a3a581c852ce6e9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
Kerberos Documentation Relay
=======================================


Philosophy.
-----------

#. The documentation must be useful;

#. The documentation must be correct;

#. The documentation must be detailed, but optimized. No verbose mode;

#. The documentation should be built incrementally;

#. The documentation should be easy to maintain;

#. 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. Normally, every document has an email link with the pre-constructed subject line similar to the following:

Please, provide your feedback on this document at krb5-bugs@mit.edu?subject=Documentation___relay_feedback