cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Andrew Grieve <agri...@chromium.org>
Subject Re: Upgrading Guides
Date Tue, 16 Jul 2013 13:21:47 GMT
The CLI guide reads quite well! Great work whoever put it together! :)

Just occurred to me that for 3.0 -> 3.1, we can probably just write a
single "CLI" upgrade guide instead of writing one for each platform (might
need caveats per-platform still).

Should we document how to create plugman-only projects as well as CLI
projects? If so, we'll need a good top-level explainer page that explains
the difference. If not, then I don't think we should mention it in our
readme. I'm hoping that we can document only the CLI flow so that there
will be less diversity in project structures out there, and it will let us
focus on doing one thing well.


On Tue, Jul 16, 2013 at 2:50 AM, Filip Maj <fil@adobe.com> wrote:

> That looks good Benn. The upgrading docs should look almost identical
> across platforms, and I think you've started it well (the big bold note
> about having to add the old core apis as plugins now).
>
> A few things that I think need doing for those docs to be complete:
>
> - Plugins need READMEs. I imagine most of them will look identical other
> than particular ids and file references. Instructions on how to install
> the plugin manually, with plugman, and with cordova-cli should be provided
> in there.
>
I don't think we want to tell them how to install the plugin manually. What
would that even look like?

- Link to the plugins in the upgrading guides, from there users can look
> at the readmes to install them.
> - The "upgrading with cordova cli" section can then be expanded with
> specific commands to run to install all of the core plugins and get the
> same app state as in pre-3.0. Maybe add notes to encourage the user to
> think about which apis are really necessary for them in their app.
>
> Let me know how that sounds folks and I can add that to the windows phone
> upgrading guide. From there the other platforms can follow suit with the
> same general upgrading notes.
>
> On 7/15/13 8:15 PM, "Benn Mapes" <benn.mapes@gmail.com> wrote:
>
> >There is a document that talks about the cordova-cli :
> >
> https://github.com/apache/cordova-docs/blob/master/docs/en/edge/guide/cli/
> >index.md
> >
> >But I don't see any mention of how to install the core plugins (or any
> >plugins...)
> >
> >For the windows phone upgrade guides I did something like this :
> >
> https://github.com/apache/cordova-docs/blob/master/docs/en/edge/guide/plat
> >forms/wp8/upgrading.md
> >
> >But I feel we might need a little bit more elaboration on this.
> >
> >
> >On Mon, Jul 15, 2013 at 6:58 PM, Shazron <shazron@gmail.com> wrote:
> >
> >> What's the story here? I assume we all have a common one, in that we
> >> require the user to install cordova-cli through npm, etc and instruct
> >>them
> >> on how to add the core plugins using this tool.
> >>
> >> Have I missed a doc somewhere already written? (probably)
> >>
>
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message