Skip to content

Conversation

@cmarcelk
Copy link
Contributor

@cmarcelk cmarcelk commented Nov 4, 2013

Added documentation on installing Cordova from npm or from the Apache
distro.

Added documentation on installing Cordova from npm or from the Apache
distro.
@mwbrooks
Copy link
Contributor

mwbrooks commented Nov 6, 2013

It feels like this has a lot of overlap with the existing CLI installation guide. @mike-sierra what are your thoughts on consolidating the "installing from Apache distro" into the npm.

In all honesty, most of this is node/npm-specific and I'm not 100% sure we even need to document it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like there are some steps in this section that we could just remove by making them in the .zips. E.g.:

  • Putting plugman in the "bundledDependencies",
  • Make source CLI's platforms.js file point to the bundled platform dirs (make config.json step unnecessary)

@agrieve
Copy link
Contributor

agrieve commented Nov 12, 2013

Super useful guide. Given that steps will change with each release, what do think about packaging this into a .md file that is included in the top-level cordova.zip file. Then, once someone unzips the mass of .zip files, they'll have instructions there to tell them what to do with them.

@cmarcelk
Copy link
Contributor Author

Given that steps will change with each release, what do think about packaging this into a .md file that is included in the top-level cordova.zip file.

I'd suggest to go even farther in that when building the cordova.zip for dist.apache.org, that we also build cordova-docs into html and include a zip of that, so a downstream user could just unzip and point their browser at index.html. But yeah, it definitely needs to readable somewhere in cordova.zip.

@mike-sierra
Copy link
Contributor

Sorry I missed this thread earlier. Not working on this any more, but yes, looks like the npm content overlaps. I don't see much benefit to collecting every potential install method on a single page of doc. As part of CB-5122, the Overview should get more fleshed out with the distinction between x-plat CLI and platform shell-tool workflows, and that's the high level at which the different install methods is best clarified.

I'd fold the extra npm commands ("view cordova versions" and "uninstall") in with the main CLI guide, aligning the install method with the likely workflow. I'd mention the more complex install-from-archive method there as well, briefly characterizing potential benefits, then link to this page, retitled & scoped more narrowly: "Installing the CLI from the Cordova Distribution." I'd also add an example use case for customizing the source, or anything else useful you can't get with the npm install. Link back to the CLI page for the more likely npm approach, etc.

Also as part of CB-5122, each "Platform Guide" should get upgraded with an install-from-archive procedure for the shell-tool workflow, with plugman installation dealt with on its own page. Maybe talk with @mbillau about this. @mwbrooks, the Android example is in that last pull req of mine.

@cmarcelk
Copy link
Contributor Author

I believe this has changed enough that it should be revisited from scratch. So I will close this pull request.

@cmarcelk cmarcelk closed this May 13, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants