Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed doc files to meet AsciiDoctor standards #4

Merged
merged 1 commit into from
Jul 21, 2014
+105 −127
Merged

Fixed doc files to meet AsciiDoctor standards #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions _build_system/Rakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,14 @@ task :build do
if not File.exists?(tgt_group_path)
Dir.mkdir(tgt_group_path)
end
if File.exists?(File.join(src_group_path,'images'))
system("cp -r #{src_group_path}/images #{tgt_group_path}")
end
#if File.exists?(File.join(src_group_path,'images'))
# system("cp -r #{src_group_path}/images #{tgt_group_path}")
#end
topic_group['Topics'].each do |topic|
src_file_path = File.join(src_group_path,"#{topic['File']}.adoc")
tgt_file_path = File.join(tgt_group_path,"#{topic['File']}.adoc")
system('cp', src_file_path, tgt_file_path)
Asciidoctor.render_file tgt_file_path, :in_place => true, :safe => :unsafe, :template_dir => builder_template_dir, :attributes => ['source-highlighter=coderay','coderay-css=style',"stylesdir=#{preview_dir}/stylesheets","imagesdir=./images",'stylesheet=origin.css','linkcss!','icons=font','idprefix=','idseparator=-','sectanchors']
Asciidoctor.render_file tgt_file_path, :in_place => true, :safe => :unsafe, :template_dir => builder_template_dir, :attributes => ['source-highlighter=coderay','coderay-css=style',"stylesdir=#{preview_dir}/stylesheets","imagesdir=#{src_group_path}/images",'stylesheet=origin.css','linkcss!','icons=font','idprefix=','idseparator=-','sectanchors']
system('rm', tgt_file_path)
end
end
Expand Down
64 changes: 19 additions & 45 deletions client_tools_install_guide/configuring_client_tools.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[Configuring_Client_Tools]]
= Configuring Client Tools
OpenShift Documentation Project <dev@lists.openshift.redhat.com>
DOC_BRANCH_VERSION
:data-uri:
:icons:

After the client tools are installed, they must be configured. The easiest method of configuring the client tools is to use the interactive setup wizard, which walks you through the configuration steps by asking several questions.

Expand All @@ -9,7 +12,7 @@ After the client tools are installed, they must be configured. The easiest metho
You must run the interactive setup wizard after installing the client tools so that your workstation is correctly configured to communicate with the remote OpenShift server.
====

The following is a sample walk through of the setup wizard, and some general information to assist you with the initial configuration. It assumes you have installed the latest version of the client tools. Use +rhc --version+ to verify the installed version, or link:Updating_Client_Tools.html[update the client tools].
The following is a sample walk through of the setup wizard, and some general information to assist you with the initial configuration. It assumes you have installed the latest version of the client tools. Use +rhc --version+ to verify the installed version, or link:updating_client_tools.html[update the client tools].


[NOTE]
Expand All @@ -21,6 +24,7 @@ The following setup wizard example was run on Windows 7. Screen outputs may vary
*Starting the Setup Wizard*

Launch the setup wizard:

----
$ rhc setup
OpenShift Client Tools (RHC) Setup Wizard
Expand All @@ -31,6 +35,7 @@ This wizard will help you upload your SSH keys, set your application namespace,
*Login Information*

The setup wizard next prompts you for the login credentials that were used to sign up for an OpenShift account. Alternatively, you can also use your Red Hat login credentials.

----
Login to openshift.redhat.com: user@example.com
Password: password
Expand All @@ -40,8 +45,6 @@ Password: password

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.



----
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'.
Generate a token now? (yes|no) yes
Expand All @@ -50,28 +53,23 @@ 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 *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.

----
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 *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.

----
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.

----
Your public ssh key must be uploaded to the OpenShift server to access code.
Upload now? (yes|no) yes
Expand All @@ -81,38 +79,28 @@ Since you do not have any keys associated with your OpenShift account, your new
Uploading key 'default' from C:\Users\User1\.ssh\id_rsa.pub ... done
----





*Installed Software*

The setup wizard verifies if Git version control software is installed on your system. Git is required to create and deploy applications to the OpenShift cloud environment. It is assumed that all the required software for your operating system is already installed as described in the earlier sections of this document. In the example below, the setup wizard verifies that Git for Windows is installed correctly.
----
The setup wizard verifies if Git version control software is installed on your system. Git is required to create and deploy applications to the OpenShift cloud environment. It is assumed that all the required software for your operating system is already installed as described in the earlier sections of this document. In the example below, the setup wizard verifies that Git for Windows is installed correctly.

----
In order to fully interact with OpenShift you will need to install and configure a git client if you have not already done so.
Documentation for installing other tools you will need for OpenShift can be found at https://openshift.redhat.com/community/developers/install-the-client-tools

We recommend these free applications:


* Git for Windows - a basic git command line and GUI client https://github.com
/msysgit/msysgit/wiki/InstallMSysGit

* TortoiseGit - git client that integrates into the file explorer http://code.
google.com/p/tortoisegit/

----





*Domain*

The setup wizard next verifies whether a domain already exists for your cloud environment. The example below assumes that a domain does not exist, and one must be created. If you did create a domain when you signed up for an OpenShift account, it is displayed here. To create a domain at this time, enter the desired name when prompted. Alternatively, you can create a domain using the OpenShift Management Console, or with the +rhc domain create+ command later. The domain named _MyDomain_ is created in the following example.
----

----
Checking for a domain ... none

Your domain is unique to your account and is the suffix of the public URLs we assign to your applications. You may configure your domain here or leave it blank and use 'rhc domain create' to create a domain later. You will not be able to create applications without first creating a domain.
Expand All @@ -121,26 +109,13 @@ Please enter a domain (letters and numbers only) |<none>|: MyDomain
Your domain name 'MyDomain' has been successfully created
----






[IMPORTANT]
====
A domain must be created before you can create OpenShift applications.


====

IMPORTANT: A domain must be created before you can create OpenShift applications.

*Applications*

Finally, the setup wizard verifies whether any applications exist under your domain. Any applications created with the Management Console are displayed here. In the example below, no applications have been created. In this case the setup wizard shows the types of applications that can be created with the associated commands. The setup wizard then completes by displaying the current gear consumption along with the gear sizes available to the given user.


Finally, the setup wizard verifies whether any applications exist under your domain. Any applications created with the Management Console are displayed here. In the example below, no applications have been created. In this case the setup wizard shows the types of applications that can be created with the associated commands. The setup wizard then completes by displaying the current gear consumption along with the gear sizes available to the given user.
----

Checking for applications ... none

Run 'rhc app create' to create your first application.
Expand All @@ -166,7 +141,6 @@ Run 'rhc app create' to create your first application.
The following gear sizes are available to you: small

Your client tools are now configured.

----

The OpenShift client tools are now configured on your system.
The OpenShift client tools are now configured on your system.
12 changes: 8 additions & 4 deletions client_tools_install_guide/installing_client_tools_on_fedora.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[Installing_Client_Tools_on_Fedora]]
= Installing Client Tools on Fedora
OpenShift Documentation Project <dev@lists.openshift.redhat.com>
DOC_BRANCH_VERSION
:data-uri:
:icons:

The OpenShift client tools are supported on Fedora 16 or later and require sudoer or root access.

Expand All @@ -16,11 +19,10 @@ You can install the client tools on Fedora operating systems by installing the R
The RPM version of the client tools is not updated as frequently as the gem maintained by the OpenShift development team.
====



*Install with YUM Package Manager*

From the terminal, install the client tools and all other required dependencies:

----
$ sudo yum install rubygem-rhc
----
Expand All @@ -44,15 +46,17 @@ $ sudo gem install rhc
*Automatic Completion Using the Tab Key*

The client tools for Fedora support the automatic completion feature of the bash shell. Run the following command and follow the instructions to enable automatic completion:

----
$ 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:

----
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 <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard.
26 changes: 13 additions & 13 deletions client_tools_install_guide/installing_client_tools_on_macosx.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[[Installing_Client_Tools_on_Mac_OS_X]]
= Installing Client Tools on Mac OS X

OpenShift Documentation Project <dev@lists.openshift.redhat.com>
DOC_BRANCH_VERSION
:data-uri:
:icons:

The OpenShift client tools are supported on Mac OS X 10.5 or later and require sudo access.
Expand All @@ -16,42 +17,41 @@ Installing the client tools on a Mac OS X operating system comprises three steps

== Install Ruby

Mac OS X Lion ships with Ruby 1.8.7 preinstalled. Previous versions of OS X included Ruby as part of the link:$$https://developer.apple.com/xcode/$$[Xcode] integrated development environment. If you are installing the client tools on a version of OS X that did not ship with Ruby preinstalled, you can install it one of two ways:
Mac OS X Lion ships with Ruby 1.8.7 preinstalled. Previous versions of OS X included Ruby as part of the https://developer.apple.com/xcode/[Xcode] integrated development environment. If you are installing the client tools on a version of OS X that did not ship with Ruby preinstalled, you can install it one of two ways:

* Use the OS X installation CD


* Download and install the link:$$https://developer.apple.com/xcode/$$[Xcode] integrated development environment from the Apple website
* Download and install the https://developer.apple.com/xcode/[Xcode] integrated development environment from the Apple website

Alternatively, if you are experienced with Mac OS software development, you can also:


* Download and install Ruby from the link:$$http://macruby.org/$$[MacRuby] website, or


* Visit link:$$http://www.ruby-lang.org/en/downloads/$$[] for help installing Ruby with homebrew
* Download and install Ruby from the http://macruby.org/[MacRuby] website, or
* Visit http://www.ruby-lang.org/en/downloads/ for help installing Ruby with homebrew

After Ruby is installed, run the following command to verify that it has installed correctly:

----
$ ruby -e 'puts "Welcome to Ruby"'
Welcome to Ruby
----

== Install Git Version Control

Although there are a number of options available to install Git version control on Mac OS X, Red Hat recommends to download and install the latest version from here: link:$$http://code.google.com/p/git-osx-installer/$$[].
Although there are a number of options available to install Git version control on Mac OS X, Red Hat recommends to download and install the latest version from here: http://code.google.com/p/git-osx-installer/

When the installation completes,, run the following command to verify that Git has installed correctly:

----
$ git --version
----

This command returns the Git version number that was installed.
This command returns the Git version number that was installed.

== Install the Client Tools

When Ruby and Git have been successfully installed, run the following command to install the client tools:

----
$ sudo gem install rhc
----

//When the installation completes, proceed to <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard.
30 changes: 13 additions & 17 deletions client_tools_install_guide/installing_client_tools_on_opensuse.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,16 @@
[[Installing_Client_Tools_on_openSUSE]]
= Installing Client Tools on openSUSE

OpenShift Documentation Project <dev@lists.openshift.redhat.com>
DOC_BRANCH_VERSION
:data-uri:
:icons:

Installing the client tools on openSUSE requires sudoer or root access and comprises three steps:

*Step 1*: Install *_Ruby_*


*Step 2*: Install *_RubyGems_*


*Step 3*: Install *_Git_*

*Step 1*: Install *_Ruby_* +
*Step 2*: Install *_RubyGems_* +
*Step 3*: Install *_Git_* +
*Step 4*: 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.
Expand All @@ -26,34 +19,36 @@ The +sudo+ command only works if the particular user is listed in the _sudoers_
== Install Ruby

From terminal, run the following command to install Ruby:

----
$ sudo zypper install ruby
----

Run the following command to verify that Ruby has installed correctly:

----
$ ruby -e 'puts "Welcome to Ruby"'
Welcome to Ruby
----




== Install RubyGems

Run the following command to install RubyGems:

----
$ sudo zypper install rubygems
----

== Install Git

Run the following command to install Git version control:

----
$ sudo zypper install git-core
----

After installation completes, run the following command to verify that Git has installed correctly:

----
$ git --version
git version 1.7.11.1
Expand All @@ -65,8 +60,9 @@ This command returns the Git version number that was installed.
== Install the Client Tools

When the required software has been successfully installed, run the following command to install the client tools:

----
$ 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 <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard.
Loading