 |
See http://blogs.sun.com/aorhan/entry/documentation_problem for some feedback.
-- Main.docteger - 11 Sep 2006
Thanks for the invaluable feedback. I'll take care of the PDF issue. I too like a PDF to open in a separate window. And I'll give your comments to the writer of the Admin Reference. This is a great time to receive them.
-- Main.docteger - 17 Aug 2006
Great idea to publish the beta docs.
To me the 2 reference guides are most important, so will start with those.
Some Admin Reference guide suggestions for future evolution:
0) The pdf should be launched in a separate window (minor - this is just a personal preference, especially to hop between different docs with the main page behaving like a launcher. Can always do a right click "open in new window").
1) It appears the doc is structured around how config data is structured and sort of assumes the user knows exactly where to look (eg dev having intimate knowledge about the code).
One thought is for "Global" vs "subconfig" vs "User" categorization be uplevelled in the intro : to introduce the concept and console navigation.
and one subsection assigned to each compoent :
Example - all session attributes together in the same subsection, appropriately labelled at what level they can be set.
So if we adopt tthis moodal no "global" - AuthN?, Session, Policy ... all exit at the same level in the doc hierarchy.
The downside is we lose out on quickly answering a q like "where are all attrs that can be set at user level" - see suggestion 2 below
2) Suggest a master index of all attributes that categorizes levels.
3) Authentication : Core needs to be uplevelled - this represents attrs common to entire auth - and hence should not be embedded within leaf auth module config.
4) Some thought needs to be given to interdependencies between attrs. Eg foo will be in efect only if bar is set. or foo applies like this if this functioanlity is turned on.
5) I am thinking SystemProperties be simlarly organized aling teh lines of (1) and (2) above.
AAA
TEST TEXT
#CrtDoc38
MORE TEXT
|