On Nov 7, 2014, at 1:39 PM, Colin Dixon <colin@...> wrote:

The documentation requirements for Lithium [0] try to take a stab at this when they say:
"Intimately related features, e.g., l2switch-switch, l2switch-switch-rest, and l2switch-switch-ui, can be documented as one noting the differences"

In the example you have, I'd imagine that covers pretty much everything if you explain which exact feature to install when and then document them together as one logical entity (which they are).

Does that make sense?

Cheers,
--Colin

[0] https://wiki.opendaylight.org/view/CrossProject:Documentation_Group:Lithium_Project_Documentation_Requirements

On Fri, Nov 7, 2014 at 3:31 PM, Luis Gomez <ecelgp@...> wrote:

Hi Colin,

My point is user-facing features are key yes but their definition is not as simple as it seems, it can be done in very many different ways (see the discussion with ofplugin project I sent earlier) and we do not want to end up with a totally disparate set of user-facing features coming from the different projects (at least I would not like). 

BR/Luis

On Nov 7, 2014, at 10:27 AM, Colin Dixon <colin@...> wrote:

We do really need to have a list of user-facing features (if any) from each project. I can add that to part of features definition in the main release plan if everyone agrees that makes sense.

We need this designation to inform what kinds of user documentation projects should generate and also to inform the installation guide as well as any automated installer/downloader/configurator we want to provide.

My gut reaction is that we just want a list of these features (possibly with options, e.g., to say that l2switch-switch, l2switch-switch-rest, and l2switch-switch-ui are "the same" feature with different options) from projects in a human-readable format and if we develop a machine parseable version with tooling, we can encourage projects to use it.

--Colin

On Fri, Nov 7, 2014 at 12:03 PM, Luis Gomez <ecelgp@...> wrote:

Dear TSC,

Yesterday call and this conversation with ofplugin project today remind me this release we should define and make some recommendations to projects on how to define their “user-facing” features. Do you agree? if so any volunteers to start working on this?

BR/Luis