Hi Sundar,
The changes (and I may not be catching them all) look to address
some of the concerns. I think the text is still very intimidating to
understand if this is a 5 minute (how short this process really is) or 1
hour task (my current feel from trying to anticipate the steps). Perhaps
adding an overview and only calling out platform specific differences
would help.
Also, another rewording I had affected which would be useful, is
how the DHCP setup occurs. It is currently hard to understand what's
different between using AI to setup the DHCP service, if one needs to only
modify their current service (on the same machine) or change a remote
server. Currently, it seems this section is a bit rough to understand,
perhaps looking at my rewrite could give you ideas?
Thank you,
Clay
On Thu, 5 Feb 2009, Sundar Yamunachari wrote:
> Clay Baenziger wrote:
>> Hi Sundar,
>> It had been suggested that the split was unclear due to the matrix that
>> results in splitting out. Is it an X86 server and X86 client, X86 server
>> and SPARC client, SPARC server and X86 client, SPARC server and SPARC
>> client?
>> The extra text makes the instructions far more daunting (~400 lines
>> more text).
>> Lastly, this makes it more clear what's necessary from a high level
>> overview for setting up an AI server down to the mechanics. (Versus getting
>> only the mechanics if there's a less concise presentation.)
>> Perhaps we could produce a set of instructions only (since the actual
>> steps are the same) and then two sections showing only output. Then the
>> user can go to just the section which interests them?
>> Thank you,
>> Clay
> Clay,
>
> Can't we fix this problem by adding text indicating that this section for
> setting up SPARC client and X86 client. Please look at the current
> instructions solves the issue mentioned in the IRC (Adding text to indicate
> that each section is for X86 client or SPARC client). This is not source code
> and this is the document I am maintaining to keep the instructions current.
> Clarity is more important than number of lines. For example if I need to some
> more text only for SPARC (some more commands to run to make sure that it is
> setup correctly), I am adding to the common section and keep on repeating
> that it is for SPARC only.
> I think having separate sections for SPARC and X86 clients makes the
> instructions clear.
>
> Thanks,
> Sundar
>>
>> On Thu, 5 Feb 2009, Sundar Yamunachari wrote:
>>
>>> Clay Baenziger wrote:
>>>> Hi all,
>>>> I don't think I've seen a code review request for the AI HTML files
>>>> in the caiman-docs gate ever before, however, Sundar pointed out these
>>>> files are getting a bunch more eyes (and I failed to do enough due
>>>> diligence in a recent update missing a few key points). So, let's do
>>>> code-review for these, starting, well now...
>>>> Could I get a a set of eyes or two to tell me if everything looks
>>>> good and accurate, or what doesn't read right in the files at:
>>>>
>>>> Original:
>>>> http://www.opensolaris.org/os/project/caiman/auto_install/AI_install_server_setup.html
>>>>
>>>> Webrev:
>>>> http://cr.opensolaris.org/~clayb/6420/webrev/
>>>> Bug:
>>>> http://defect.opensolaris.org/bz/show_bug.cgi?id=6420
>>>>
>>>> Thank you,
>>>> Clay
>>>> _______________________________________________
>>>> caiman-discuss mailing list
>>>> caiman-discuss at opensolaris.org
>>>> http://mail.opensolaris.org/mailman/listinfo/caiman-discuss
>>>>
>>> Clay,
>>>
>>> Why do you have to combine the X86 and SPARC setup instructions in to
>>> one set of instructions? Is there any request that there should be only
>>> one section that contains both X86 and SPARC setup? Even though the setup
>>> instructions are similar, the output is different. Putting them in the
>>> same section will be more confusing. I want documentation to be clear
>>> even if involves duplication of steps.
>>>
>>> Thanks,
>>> Sundar
>>>
>
>
