Online ==>> Master

_build_cfg.yml

@@ -17,13 +17,30 @@
 Name: OpenShift Documentation
 Dir: welcome
 Topics:
-  - Name: Overview
+  - Name: Welcome
     File: index
 
+---
+Name: Getting Started
+Dir: getting_started
+Topics:
+  - Name: Overview
+    File: overview
+  - Name: Interacting with OpenShift
+    File: interfaces
+  - Name: Preliminary Steps
+    File: preliminary_steps
+  - Name: Creating an Application
+    File: create_app
+  - Name: Deploying an Application
+    File: deploy_app
+
 ---
 Name: Installing Client Tools
 Dir: client_tools_install_guide
 Topics:
+  - Name: Overview
+    File: overview
   - Name: On Fedora
     File: installing_client_tools_on_fedora
   - Name: On OS X
@@ -60,6 +77,8 @@ Topics:
 Name: Developing Cartridges
 Dir: cartridge_specification_guide
 Topics:
+  - Name: Overview
+    File: overview
   - Name: Managed Files
     File: managed_files
   - Name: Locking Cartridges

cartridge_specification_guide/managed_files.adoc

@@ -28,35 +28,35 @@ Some entries allow string values. These values return directly without any modif
 						File Pattern
 					|
 						Files that an application developer can read but not update
-					|link:/cartridge_spec_guide/locking_cartridges[Locking Cartridges]
+					|link:locking_cartridges.html[Locking Cartridges]
 |
 						[parameter]#snapshot_exclusions#
 					|
 						File Pattern
 					|
 						Array of file names not to backup from the gear when +rhc snapshot+ runs
-					|link:/cartridge_spec_guide/backing_up_and_restoring_cartridges[Backing Up and Restoring Cartridges]
+					|link:backing_up_and_restoring_cartridges.html[Backing Up and Restoring Cartridges]
 |
 						[parameter]#setup_rewritten#
 					|
 						File Pattern
 					|
 						Files that are removed before running +setup+
-					|link:/cartridge_spec_guide/cartridge_scripts[Cartridge Scripts]
+					|link:cartridge_scripts.html[Cartridge Scripts]
 |
 						[parameter]#process_templates#
 					|
 						File Pattern
 					|
 						ERB templates that are rendered after running +setup+
-					|link:/cartridge_spec_guide/cartridge_scripts#embedded_ruby_processing[Embedded Ruby (ERB) Processing]
+					|link:cartridge_scripts.html#embedded_ruby_processing[Embedded Ruby (ERB) Processing]
 |
 						[parameter]#restore_transforms#
 					|
 						Strings
 					|
 						Set of regex transforms for rewriting file names when +rhc restore+ is run.
-					|link:/cartridge_spec_guide/backing_up_and_restoring_cartridges[Backing Up and Restoring Cartridges]
+					|link:backing_up_and_restoring_cartridges.html[Backing Up and Restoring Cartridges]
 |===
 
 The following example demonstrates the structure of a basic [filename]#$managed_files.yml# file: 

cartridge_specification_guide/openshift_cartridge_reference.adoc

@@ -31,7 +31,7 @@ To support multiple software versions within one cartridge, create symbolic link
 
 When creating an instance of your cartridge for use by a gear, OpenShift copies the files, links, and directories from the cartridge library, with the exception of the [filename]#$cartridge_name/usr/# directory. The [filename]#$cartridge_name/usr/# directory is symbolically linked to the gear's cartridge instance. This link enables all cartridge instances to share libraries and other data. 
 
-See link:locking_cartridges[Locking Cartridges] for more information on customizing a cartridge instance. 
+See link:locking_cartridges.html[Locking Cartridges] for more information on customizing a cartridge instance. 
 
 [[cartridge_metadata_elements]]
 == Cartridge Metadata Elements
@@ -320,7 +320,7 @@ Additional-Control-Actions:
 [[endpoints]]
 === Endpoints
 
-See link:exposing_services[Exposing Services]. 
+See link:exposing_services.html[Exposing Services]. 
 
 [[example_openshift.conf.erb_file]]
 == Example openshift.conf.erb File

cartridge_specification_guide/overview.adoc

@@ -0,0 +1,6 @@
+= Overview
+{product-version}
+:data-uri:
+:icons:
+
+These topics provide guidelines and specifications about components and services that are essential to the design of custom cartridges. This information helps developers to create custom cartridges so that application components that are not currently supported by the available cartridges can be integrated with OpenShift.

client_tools_install_guide/configuring_client_tools.adoc

@@ -43,7 +43,7 @@ Password: password
 
 *Authorization Tokens*
 
-You are then prompted to generate an authorization token. Answering _++yes++_ will store a token in your home directory to be used on subsequent requests. When it expires, you are prompted for your password again. 
+You are then prompted to generate an authorization token. Answering [userinput]#yes# stores a token in your home directory to be used on subsequent requests. When it expires, you are prompted for your password again. 
 
 ----
 OpenShift can create and store a token on disk which allows to you to access the server without using your password. The key is stored in your home directory and should be kept secret. You can delete the key at any time by running 'rhc logout'.
@@ -53,22 +53,22 @@ Generating an authorization token for this client ... lasts about 1 day
 
 *Configuration File*
 
-With your login credentials, the setup wizard creates the *express.conf* configuration file in your home directory. In the following example, the *express.conf* file is created in the *C:\Users\User1\.openshift* directory.
+With your login credentials, the setup wizard creates the [filename]#express.conf# configuration file in your home directory. In the following example, the [filename]#express.conf# file is created in the [filename]#C:\Users\User1\.openshift# directory.
 
 ----
 Saving configuration to C:\Users\User1\.openshift\express.conf ... done
 ----
 
 *SSH Keys*
 
-Next, the setup wizard configures the SSH keys so that your system can authenticate with the remote server. Because this is the initial configuration, it is assumed no existing SSH keys are found on your system. Therefore, the setup wizard generates a new pair of SSH keys, named *id_rsa* and *id_rsa.pub*, and saves them in your home directory. In the following example the SSH keys are generated and saved in the *C:\Users\User1\.ssh* directory.
+Next, the setup wizard configures the SSH keys so that your system can authenticate with the remote server. Because this is the initial configuration, it is assumed no existing SSH keys are found on your system. Therefore, the setup wizard generates a new pair of SSH keys, named [filename]#id_rsa# and [filename]#id_rsa.pub#, and saves them in your home directory. In the following example the SSH keys are generated and saved in the [filename]#C:\Users\User1\.ssh# directory.
 
 ----
 No SSH keys were found. We will generate a pair of keys for you.
 Created: C:\Users\User1\.ssh\id_rsa.pub
 ----
 
-After the new SSH keys are generated, the public key, *id_rsa.pub*, must be uploaded to the OpenShift server to authenticate your system to the remote server. Enter a name to use for your key, or leave it blank to use the default name. In the following example the default name is used.
+After the new SSH keys are generated, the public key, [filename]#id_rsa.pub#, must be uploaded to the OpenShift server to authenticate your system to the remote server. Enter a name to use for your key, or leave it blank to use the default name. In the following example the default name is used.
 
 ----
 Your public ssh key must be uploaded to the OpenShift server to access code.

client_tools_install_guide/installing_client_tools_on_fedora.adoc

@@ -1,4 +1,4 @@
-= Installing Client Tools on Fedora
+= Install Client Tools on Fedora
 {product-author}
 {product-version}
 :data-uri:
@@ -8,7 +8,7 @@ The OpenShift client tools are supported on Fedora 16 or later and require sudoe
 
 [NOTE]
 ====
-The +sudo+ command only works if the particular user is listed in the +sudoers+ file. As an alternative to sudo access, you can activate a root terminal with the +su+ command and the root password. If you activate a root terminal, omit +sudo+ from the commands shown in the examples. Be sure to close the root terminal when the installation process is complete. 
+The +sudo+ command only works if the particular user is listed in the +sudoers+ file. As an alternative to sudo access, you can activate a root terminal with the +su+ command and the root password. If you activate a root terminal, omit `sudo` from the commands shown in the examples. Be sure to close the root terminal when the installation process is complete. 
 ====
 
 You can install the client tools on Fedora operating systems by installing the RPM with the YUM package manager, or by installing the gem.
@@ -27,7 +27,7 @@ From the terminal, install the client tools and all other required dependencies:
 $ sudo yum install rubygem-rhc
 ----
 
-*Installing with Gem*
+*Install with Gem*
 
 1. From the terminal, install Ruby and RubyGems if they are not already installed:
 +
@@ -53,10 +53,10 @@ $ rhc setup --autocomplete
 
 You may have to close your current terminal session, and open a new session to automatically source the bash completion script. 
 
-If the automatic completion feature is not persistent when you open a new terminal session, the automatic completion script for the client tools must be sourced in the *_.bashrc_* file in your home directory. Do this by adding the following line to to your *_.bashrc_* file:
+If the automatic completion feature is not persistent when you open a new terminal session, the automatic completion script for the client tools must be sourced in the [flename]#.bashrc# file in your home directory. Do this by adding the following line to to your [flename]#.bashrc# file:
 
 ----
 source /etc/bash_completion.d/rhc
 ----
 
-//When the installation completes, proceed to <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard. 
+When the installation completes, proceed to link:configuring_client_tools.html[configure] the client tools using the interactive setup wizard. 

client_tools_install_guide/installing_client_tools_on_macosx.adoc

@@ -54,4 +54,4 @@ When Ruby and Git have been successfully installed, run the following command to
 $ sudo gem install rhc
 ----
 
-//When the installation completes, proceed to <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard. 
+When the installation completes, proceed to link:configuring_client_tools.html[configure] the client tools using the interactive setup wizard. 

client_tools_install_guide/installing_client_tools_on_opensuse.adoc

@@ -65,4 +65,4 @@ When the required software has been successfully installed, run the following co
 $ sudo gem install rhc
 ----
 
-//When the installation completes, proceed to <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard. 
+When the installation completes, proceed to link:configuring_client_tools.html[configure] the client tools using the interactive setup wizard. 

client_tools_install_guide/installing_client_tools_on_rhel.adoc

@@ -1,4 +1,4 @@
-= Installing Client Tools on Red Hat Enterprise Linux
+= Install Client Tools on Red Hat Enterprise Linux
 {product-author}
 {product-version}
 :data-uri:
@@ -12,10 +12,10 @@ You must have the following to successfully install the client tools:
 
 [NOTE]
 ====
-The +sudo+ command only works if the particular user is listed in the *_sudoers_* file. As an alternative to sudo access, you can activate a root terminal with the +su+ command and the root password. If you activate a root terminal, omit +sudo+ from the commands shown in the examples. Be sure to close the root terminal after the installation completes. 
+The +sudo+ command only works if the particular user is listed in the *_sudoers_* file. As an alternative to sudo access, you can activate a root terminal with the +su+ command and the root password. If you activate a root terminal, omit `sudo` from the commands shown in the examples. Be sure to close the root terminal after the installation completes. 
 ====
 
-== Installing RubyGems
+== Install RubyGems
 
 If the RubyGems package is not already installed, you must enable the Red Hat Enterprise Linux optional repository channel. The RubyGems package dependencies are then automatically resolved when the client tools are installed. 
 
@@ -31,7 +31,7 @@ If you are using the classic RHN subscription, use the following command to enab
 $ sudo rhn-channel --add --channel=[architecture]-[operating_system]-optional-6
 ----
 
-* _++architecture++_: your system architecture. Enter either _i386_ or *x86_64*
+* _++architecture++_: your system architecture. Enter either _i386_ or _x86_64_
 * _++operating system++_: type of operating system installed. Enter either _workstation_ or _server_. 
 
 For example, if you have Red Hat Enterprise Linux Workstation 6 or later installed on a 64-bit x86 computer, and you are using the classic Red Hat Network subscription, run the following command to enable the optional repository:
@@ -40,7 +40,7 @@ For example, if you have Red Hat Enterprise Linux Workstation 6 or later install
 $ sudo rhn-channel --add --channel=rhel-x86_64-workstation-optional-6
 ----
 
-== Installing Client Tools
+== Install Client Tools
 
 Ensure that the RubyGems software package is installed on your system. Otherwise, the optional repository channel must be enabled on systems that are registered on RHN.
 
@@ -82,10 +82,10 @@ $ rhc setup --autocomplete
 
 You may have to close your current terminal session, and open a new session to automatically source the bash completion script. 
 
-If the automatic completion feature is not persistent when you open a new terminal session, the automatic completion script for the client tools must be sourced in the *_.bashrc_* file in your home directory. Do this by adding the following line to to your *_.bashrc_* file:
+If the automatic completion feature is not persistent when you open a new terminal session, the automatic completion script for the client tools must be sourced in the [flename]#.bashrc# file in your home directory. Do this by adding the following line to to your [flename]#.bashrc# file:
 
 ----
 source /etc/bash_completion.d/rhc
 ----
 
-//When the installation completes, proceed to <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard. 
+When the installation completes, proceed to link:configuring_client_tools.html[configure] the client tools using the interactive setup wizard.  

client_tools_install_guide/installing_client_tools_on_ubuntu_debian.adoc

@@ -1,10 +1,10 @@
-= Installing Client Tools on Ubuntu and Debian
+= Install Client Tools on Ubuntu and Debian
 {product-author}
 {product-version}
 :data-uri:
 :icons:
 
-Installing the client tools on Ubuntu or Debian requires sudoer or root access and comprises four steps:
+Install the client tools on Ubuntu or Debian requires sudoer or root access and comprises four steps:
 
 *Step 1*: Install *_Ruby_*  
 
@@ -19,7 +19,7 @@ Installing the client tools on Ubuntu or Debian requires sudoer or root access a
 The +sudo+ command only works if the particular user is listed in the _sudoers_ file. As an alternative to sudo access, you can activate a root terminal with the +su+ command and the root password. If you activate a root terminal, omit +sudo+ from the commands shown in the examples. Be sure to close the root terminal after the installation completes. 
 ====  
 
-== Installing Ruby
+== Install Ruby
 
 From terminal, run the following command to install Ruby:
 
@@ -34,15 +34,15 @@ $ ruby -e 'puts "Welcome to Ruby"'
 Welcome to Ruby
 ----
 
-== Installing RubyGems
+== Install RubyGems
 
 Run the following command to install RubyGems:
 
 ----
 $ sudo apt-get install rubygems
 ----
 
-== Installing Git
+== Install Git
 
 Run the following command to install Git version control:
 
@@ -58,7 +58,7 @@ $ git --version
 
 This command returns the Git version number that was installed. 
 
-== Installing Client Tools
+== Install Client Tools
 
 When the required software has been successfully installed, run the following command to install the client tools:  
 
@@ -68,9 +68,9 @@ $ sudo gem install rhc
 
 == Installation Issues and Tips
 
-*Executing Client Tool Commands from Any Directory*
+*Execute Client Tool Commands from Any Directory*
 
-On Ubuntu and other Debian based distributions, the client tools by default are stored in the `/var/lib/gems/1.8/bin` directory. Therefore, all client tool commands must be executed from this directory, and you must prepend `./` to each command. 
+On Ubuntu and other Debian based distributions, the client tools by default are stored in the [filename]#/var/lib/gems/1.8/bin# directory. Therefore, all client tool commands must be executed from this directory, and you must prepend [filename]#./# to each command. 
 
 However, this behavior can be changed by adding the client tools to the PATH environment variable so that you can run client tool commands from any directory. Run the following command to add the client tools to the PATH environment variable, and make it persistent for an entire terminal session:  
 
@@ -80,10 +80,10 @@ $ sudo export PATH=/var/lib/gems/1.8/bin:$PATH
 
 Now you can run client tool commands from any directory in the current Terminal session. Note that you must do this each time you close the current Terminal session and start a new one. 
 
-For a more permanent solution, add the *export PATH=/var/lib/gems/1.8/bin:$PATH* command to your *_.bashrc_* file. Therefore, each time a new Terminal session is started, the client tools are automatically added to the PATH environment variable. You can then run all client tool commands from any directory in Terminal. 
+For a more permanent solution, add the `export PATH=/var/lib/gems/1.8/bin:$PATH` command to your [flename]#.bashrc# file. Therefore, each time a new Terminal session is started, the client tools are automatically added to the PATH environment variable. You can then run all client tool commands from any directory in Terminal. 
 
 
-*Making Client Tools Available to All Users*
+*Make Client Tools Available to All Users*
 
 Initially the OpenShift Online client tools are only available to the user installed them. Run the following command to make the client tools available for all users on an Ubuntu system:
 
@@ -93,4 +93,4 @@ $ sudo ln -s /var/lib/gems/1.8/bin/rhc* /usr/bin/
 
 This creates a symbolic link to the client tools binaries in the default search path, and make the client tools available to all users on that system. 
 
-//When the installation completes, proceed to <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard. 
+When the installation completes, proceed to link:configuring_client_tools.html[configure] the client tools using the interactive setup wizard. 

client_tools_install_guide/installing_client_tools_on_windows.adoc

@@ -3,6 +3,7 @@
 {product-version}
 :data-uri:
 :icons:
+:experimental:
 
 The OpenShift Client Tools are supported on the following Windows operating systems: 
 
@@ -36,14 +37,14 @@ Before you can install the client tools, you must download and install *_RubyIns
 //[[img-rubyinstaller]]
 //image:2830.png[image]
 
-2. Double-click the executable RubyInstaller file downloaded in the previos step to launch the RubyInstaller installation wizard. Accept the _Ruby License Agreement_ and click btn:[OK].
+2. Double-click the executable RubyInstaller file downloaded in the previos step to launch the RubyInstaller installation wizard. Accept the *Ruby License Agreement* and click btn:[OK].
 
-3. Select the _Add Ruby executables to your PATH_ check box, and click btn:[Install] to begin the installation. 
+3. Select the *Add Ruby executables to your PATH* check box, and click btn:[Install] to begin the installation. 
 +
 .Select PATH
 image:2829.png[image]
 +
-Click *Finish* when the install completes. 
+Click btn:[Finish] when the install completes. 
 
 === Install Git Version Control
 
@@ -75,4 +76,4 @@ a. Click btn:[Start], type *cmd* in the *Start Search* text box, and then click
 $ gem install rhc
 ----
 
-//When the installation completes, proceed to <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard. 
+When the installation completes, proceed to link:configuring_client_tools.html[configure] the client tools using the interactive setup wizard. 

client_tools_install_guide/overview.adoc

@@ -0,0 +1,8 @@
+= Overview
+{product-version}
+:data-uri:
+:icons:
+
+These topics provide instructions on how to install and configure the client tools on workstations with supported operating systems. The client tools allow developers and administrators to create, build, and deploy applications on OpenShift and provide advance features for managing a cloud environment.
+
+Select the appropriate operating system for specific instructions on how to install the client tools.