[
https://issues.apache.org/jira/browse/CB-5122?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13813281#comment-13813281
]
Mike Billau commented on CB-5122:
---------------------------------
Sure [~sierra] feel free. I'm going to take another pass over the Overview,
Plugman, and CLI sections tomorrow (found a few undocumented CLI commands) and
then hopefully we can mark those ones as finished. Then I can help you or find
another task - anything in particular you could use extra help on?
> Document supported workflows
> ----------------------------
>
> Key: CB-5122
> URL: https://issues.apache.org/jira/browse/CB-5122
> Project: Apache Cordova
> Issue Type: Bug
> Components: Docs
> Affects Versions: 3.1.0
> Reporter: Mike Billau
> Assignee: Mike Sierra
>
> Based on the recent discussion here [1]we should document the two different
> supported Cordova workflows: using the CLI, and using plugman and bin
> scripts.
> Some of this documentation already exists but needs to be clarified and
> improved:
> {{Overview guide --> "Development Paths" section}}. This talks about getting
> started with the CLI and then mentions that you can switch to the
> platform-specific SDK tools. This section should be rewritten to make it
> clear that there are two distinct workflows, and that both are okay and
> supported. It could list out some pros and cons of each workflow (I'm sure we
> won't have any trouble finding those ;)). It should be prescriptive in that
> users should be following one of the two workflows, but it shouldn't make any
> statements about which is better.
> {{"The Command-line Interface" guide}} --> The "CLI workflow" guide. It
> generally looks complete except for some missing functionality that is
> documented in the CLI's README.md file (tests, hooks, some commands (serve),
> some merges info).
> {{Platform Guides --> (Platform) --> (Platform) Command-line tools}} --> Each
> platform has a "Command-line tools" doc that explains all of the command line
> tools for that project and how to use them. We need to go through these
> guides and verify that they are up to date and include all of the lower level
> command line tools and scripts. It should read like a tutorial in the same
> way that the Command-line Interface guide does.
> {{"Using Plugman to Manage Plugins"}} First, this guide needs to get exposed;
> I can't find any way to get to this guide from the docs and even had to ask a
> user how she managed to find it (a link from Plugman's readme!). This guide
> needs to be expanded quite a bit; we can probably fold most/all of Plugman's
> README.md file into this guide since it will be platform agnostic.
> I think those are the only pieces in the docs that need to be changed.
> [1] http://callback.markmail.org/thread/5nr7dgkquse4gdkl
> [2]
> http://cordova.apache.org/docs/en/edge/guide_overview_index.md.html#Overview
> [3] http://cordova.apache.org/docs/en/edge/plugin_ref_plugman.md.html
--
This message was sent by Atlassian JIRA
(v6.1#6144)
