Repository: lens Updated Branches: refs/heads/master b72c76041 -> d457dd0de
LENS-113: Document how to document a feature in contributor guide Project: http://git-wip-us.apache.org/repos/asf/lens/repo Commit: http://git-wip-us.apache.org/repos/asf/lens/commit/d457dd0d Tree: http://git-wip-us.apache.org/repos/asf/lens/tree/d457dd0d Diff: http://git-wip-us.apache.org/repos/asf/lens/diff/d457dd0d Branch: refs/heads/master Commit: d457dd0de755cfe46e9bb2b15ea837bdec5ff843 Parents: b72c760 Author: Amareshwari Sriramadasu <amareshw...@gmail.com> Authored: Wed Sep 23 11:42:31 2015 +0530 Committer: raju.bairishetti <r...@apache.org> Committed: Wed Sep 23 11:42:31 2015 +0530 ---------------------------------------------------------------------- src/site/apt/developer/contribute.apt | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lens/blob/d457dd0d/src/site/apt/developer/contribute.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/developer/contribute.apt b/src/site/apt/developer/contribute.apt index ef3854a..6183b07 100644 --- a/src/site/apt/developer/contribute.apt +++ b/src/site/apt/developer/contribute.apt @@ -483,11 +483,34 @@ Developer Documentation : How to contribute to Apache Lens? ** Feature documentation - TODO + End users of Lens include : -** Design and architecture documentation + * Querying users : mostly un-aware of system details, and un-aware of underlying data layout. - TODO + * Schema designer : Schema designer would understand the data model and come up with schema for their data. + + * Server administrator : Lens server administrator understands the server setup, how multiple execution engines can be + added/removed and how to support multiple storage. + + * Developer : Developers can develop new drivers, new features on server or client or anything to do with code. + + + Whenever a new feature is added to Lens, the developer should understand to whom the feature is applicable and put + it in proper menu - "User Menu" for Querying users and schema designers; "Admin Menu" for server administrators and + "Developer Menu" for developer related features. + + The following details about the feature should be documented : + + * The use case : Explaining Why the feature is required. + + * The feature itself : What the feature is. + + * How to enable the feature, if any. + + * Who are the users of feature and who are not, if any. + + The design documentation related to the feature can go in developer documentation or + {{{https://cwiki.apache.org/confluence/display/LENS/DesignDocs} Design docs}}. ** Confluence usage
