Repository: lens Updated Branches: refs/heads/master e5b793c83 -> e18488105
LENS-113 : (Incremental) Document how to add feature documentation Project: http://git-wip-us.apache.org/repos/asf/lens/repo Commit: http://git-wip-us.apache.org/repos/asf/lens/commit/e1848810 Tree: http://git-wip-us.apache.org/repos/asf/lens/tree/e1848810 Diff: http://git-wip-us.apache.org/repos/asf/lens/diff/e1848810 Branch: refs/heads/master Commit: e1848810591dd9c31e0993dbed977bcf0c627643 Parents: e5b793c Author: Amareshwari Sriramadasu <amareshw...@gmail.com> Authored: Thu Oct 1 15:58:37 2015 +0530 Committer: Rajat Khandelwal <rajatgupt...@gmail.com> Committed: Thu Oct 1 15:58:37 2015 +0530 ---------------------------------------------------------------------- src/site/apt/developer/contribute.apt | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lens/blob/e1848810/src/site/apt/developer/contribute.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/developer/contribute.apt b/src/site/apt/developer/contribute.apt index 6183b07..5b6fbaf 100644 --- a/src/site/apt/developer/contribute.apt +++ b/src/site/apt/developer/contribute.apt @@ -509,8 +509,14 @@ Developer Documentation : How to contribute to Apache Lens? * Who are the users of feature and who are not, if any. + * Illustration with example would be very welcome + The design documentation related to the feature can go in developer documentation or - {{{https://cwiki.apache.org/confluence/display/LENS/DesignDocs} Design docs}}. + {{{https://cwiki.apache.org/confluence/display/LENS/DesignDocs} Design docs}}. It would be necessary to add in which + version the feature is available if the documentation is in confluence. Also when behavior is modified or improved on + existing features, version tagging is quite useful. Any defaults (in terms of config or behavior) assumed with the + feature should also be highlighted. Configuration descriptions should be linked to config apt files, so that they + are always in sync with code. ** Confluence usage
