You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/09/22 02:19:46 UTC
docs commit: Updating README text to be more clear.
Repository: cordova-docs
Updated Branches:
refs/heads/cordova-website b8f601df2 -> b7afc3020
Updating README text to be more clear.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/b7afc302
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/b7afc302
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/b7afc302
Branch: refs/heads/cordova-website
Commit: b7afc3020c8f6b20332ee30de8cf52d706dcda78
Parents: b8f601d
Author: Dmitry Blotsky <dm...@gmail.com>
Authored: Mon Sep 21 17:19:33 2015 -0700
Committer: Dmitry Blotsky <dm...@gmail.com>
Committed: Mon Sep 21 17:19:33 2015 -0700
----------------------------------------------------------------------
README.md | 39 +++++++++++++++++++++++++++------------
1 file changed, 27 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/b7afc302/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 8b43695..84a2450 100644
--- a/README.md
+++ b/README.md
@@ -14,14 +14,19 @@ On Mac OS X, install Homebrew from [this site][homebrew], and then run:
On Windows, follow these steps:
-1. Download this [Ruby installer][install_ruby].
-1. Run the downloaded file.
+1. Download [this installer][ruby_installer] from [this page][ruby_downloads].
+
+2. Run the downloaded file.
+
1. Use the default installation path (usually `C:\Ruby22`).
- 1. Make sure the 'add executable to path' option is checked.
-1. Download the Ruby DevKit self-extracting archive from the [same website][install_ruby].
-1. Run this downloaded file.
+ 1. Make sure the **'add executable to path'** option is checked.
+
+3. Download [this Ruby DevKit self-extracting archive][ruby_devkit] from the [same website][ruby_downloads].
+
+4. Run the downloaded file.
1. Use the following extraction path: `C:\Ruby22DevKit`.
-1. Open `cmd.exe`
+
+5. Open `cmd.exe`
1. Go to the extraction path:
cd C:\Ruby22DevKit
@@ -30,6 +35,7 @@ On Windows, follow these steps:
ruby dk.rb init
ruby dk.rb install
+
1. Close `cmd.exe`.
On Linux, run the commands from [this site][ruby_linux] that apply to your Linux distribution.
@@ -42,7 +48,7 @@ Verify the installation by running:
## JavaScript
-On Windows and Mac OS X, go to [this site][nodejs], and click the "Install" button. Then run the downloaded file and follow the on-screen instructions. Make sure that the option to install NPM is enabled, if you see one.
+On Windows and Mac OS X, go to [this site][nodejs], and click the "Install" button. Then run the downloaded file and follow the on-screen instructions. Make sure that the option to **install NPM** is enabled, if you see one.
On Linux, follow the instructions on [this site][linux_node].
@@ -68,7 +74,9 @@ Building
To build the whole website, run:
- node_modules/.bin/gulp build
+ node_modules/.bin/gulp build --prod
+
+The built website will be in a folder called `build-prod`.
Developing
==========
@@ -94,15 +102,20 @@ First, inspect `_prod.yml` to check that the correct `baseurl` is used. For pre-
gulp build --prod
-A folder called `build-prod` will be created, and will contain the whole website. Then, in a directory *outside* of the `cordova-docs` repository, check out the SVN repository that contains the currently deployed website by running (committer access required):
+A folder called `build-prod` will be created, and will contain the whole website. Then, in a directory *outside* of the `cordova-docs` repository, check out the SVN repository that contains the currently deployed website by running the following command (committer access required):
svn checkout https://svn.apache.org/repos/asf/cordova/site cordova-website
Now, copy the `cordova-docs/build-prod/` directory to the corresponding directory in SVN (i.e. something like `cordova-website/public/use-the-force-luke/` for the pre-production deployment, or just `cordova-website/public/` for the production deployment):
- cp -R cordova-docs/build-prod/ cordova-website/public/use-the-force-luke/
+ cp -R cordova-docs/build-prod/* cordova-website/public/use-the-force-luke/
+
+Finally, go into the `cordova-website` directory and commit *all* the changes introduced the newly copied files. The commit might take a while (upwards of 30min), depending on the number of files copied.
+
+Working on the Documentation
+============================
-Finally, go into the cordova-website directory and commit *all* the changes introduced the newly copied files. The commit might take a while (upwards of 30min), depending on the number of files copied.
+Refer to this [README.md](doc/README/en/edge/README.md) for information about writing documentation.
Adding a Tool or a Showcase App
===============================
@@ -219,7 +232,9 @@ Ask for help on the IRC channel: #cordova on irc.freenode.net.
[ruby_linux]: https://www.ruby-lang.org/en/documentation/installation/#package-management-systems
[homebrew]: http://brew.sh/
[linux_node]: https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories#installing-node-js-v0-12
-[install_ruby]: http://rubyinstaller.org/downloads/
+[ruby_downloads]: http://rubyinstaller.org/downloads/
+[ruby_installer]: http://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.2.3.exe
+[ruby_devkit]: http://dl.bintray.com/oneclick/rubyinstaller/DevKit-mingw64-32-4.7.2-20130224-1151-sfx.exe
[nodejs]: https://nodejs.org/
[install_pip]: https://pip.pypa.io/en/latest/installing.html
[svn]: http://svnbook.red-bean.com/en/1.7/svn.intro.quickstart.html
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org