[ 
https://issues.apache.org/jira/browse/KNOX-1209?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16401090#comment-16401090
 ] 

Larry McCay commented on KNOX-1209:
-----------------------------------

Excellent point about the "at least WebHDFS, WebHCAT and Oozie..." statement. 
This seems to be related to the samples that are discussed in the section that 
follows but may have evolved in such a way that it isn't clear to be about that 
anymore.

[~smore] - any thoughts on the commented out line there?

The difficulties you are having with sections like the Shared Providers is 
related to one of the things that I find difficult about the style of these 
docs. Each feature is discussed pretty well but it is hard to know how they fit 
together and sometimes without that context they don't make a lot of sense 
alone.

I've always felt that we needed another doc style that is more usecase driven 
that can point into this guide as more of a reference for details but higher 
level recipes for the usecases that drive the features are needed. We've tried 
to do that in a number of wiki's but they don't really have proper visibility 
to fill the gap.

I do think we need an Admin Guide and then the Users Guide can be more of a 
reference.

Now, to just find the time.

 

> Improvements to the 1.1.0 User Guide
> ------------------------------------
>
>                 Key: KNOX-1209
>                 URL: https://issues.apache.org/jira/browse/KNOX-1209
>             Project: Apache Knox
>          Issue Type: Improvement
>          Components: Site
>            Reporter: Lars Francke
>            Assignee: Lars Francke
>            Priority: Minor
>             Fix For: 1.1.0
>
>         Attachments: KNOX-1209.1.patch
>
>
> I did this two years ago in KNOX-646 and I've done it again. I did read 
> through the whole User Guide and fixed obvious mistakes, inconsistencies and 
> formatting things.
> I'm sorry for the "code dump" I hope it's still useful. The patch is pretty 
> large but the changes itself are pretty small.
> As last time I won't have much time to work on this patch.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to