You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lens.apache.org by "amareshwarisr ." <am...@gmail.com> on 2014/11/28 02:06:50 UTC
cwiki usage for Lens
Hello all,
Confluence space for lens has been setup by infra.
Home : https://cwiki.apache.org/confluence/display/LENS/Lens+Home
I created some child pages
https://cwiki.apache.org/confluence/collector/pages.action?key=LENS
Everyone is welcome to update the docs. If you are interested please send
mail for access with your id.
I'm trying to put for what cwiki should be used and for what not, your
suggestions and comments are welcome
Cwiki should be used for documentation that cannot go into code. This falls
into following main categories
- Design doc for a feature, which is just proposed or it is under
implementation
- Once the feature is implemented doc should be present in project
documentation updated through code
- Project roadmap
- Discussions : Placeholder for discussions that cannot be done in jira
- Presentations : Links to slideshare or google docs
- Events : Developer/User Meetup minutes
Cwiki should not be used for documentation that is already present in code,
which is the following
- Architecture documentation
- Feature documentation
- How to contribute/commit/release pages (right now they are in code) -
and i think they should be part of project documentation than wiki
- Generated doc for REST API/Javadoc
- Getting started pages
Thanks
Amareshwari