Skip to content

Commit 8e8bafc

Browse files
nhrnhr
committed
Merge pull request #4 from nhr/client_doc_image_fixes
Fixed doc files to meet AsciiDoctor standards
2 parents f7e4ec2 + 5a1044b commit 8e8bafc

9 files changed

+105
-127
lines changed

‎_build_system/Rakefile‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,14 +123,14 @@ task :build do
123123
if not File.exists?(tgt_group_path)
124124
Dir.mkdir(tgt_group_path)
125125
end
126-
if File.exists?(File.join(src_group_path,'images'))
127-
system("cp -r #{src_group_path}/images #{tgt_group_path}")
128-
end
126+
#if File.exists?(File.join(src_group_path,'images'))
127+
# system("cp -r #{src_group_path}/images #{tgt_group_path}")
128+
#end
129129
topic_group['Topics'].each do |topic|
130130
src_file_path = File.join(src_group_path,"#{topic['File']}.adoc")
131131
tgt_file_path = File.join(tgt_group_path,"#{topic['File']}.adoc")
132132
system('cp', src_file_path, tgt_file_path)
133-
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']
133+
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']
134134
system('rm', tgt_file_path)
135135
end
136136
end

‎client_tools_install_guide/configuring_client_tools.adoc‎

Lines changed: 19 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
[[Configuring_Client_Tools]]
21
= Configuring Client Tools
2+
OpenShift Documentation Project <dev@lists.openshift.redhat.com>
3+
DOC_BRANCH_VERSION
4+
:data-uri:
5+
:icons:
36

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

@@ -9,7 +12,7 @@ After the client tools are installed, they must be configured. The easiest metho
912
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.
1013
====
1114

12-
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].
15+
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].
1316

1417

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

2326
Launch the setup wizard:
27+
2428
----
2529
$ rhc setup
2630
OpenShift Client Tools (RHC) Setup Wizard
@@ -31,6 +35,7 @@ This wizard will help you upload your SSH keys, set your application namespace,
3135
*Login Information*
3236

3337
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.
38+
3439
----
3540
Login to openshift.redhat.com: user@example.com
3641
Password: password
@@ -40,8 +45,6 @@ Password: password
4045

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

43-
44-
4548
----
4649
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'.
4750
Generate a token now? (yes|no) yes
@@ -50,28 +53,23 @@ Generating an authorization token for this client ... lasts about 1 day
5053

5154
*Configuration File*
5255

53-
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.
54-
----
56+
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.
5557

58+
----
5659
Saving configuration to C:\Users\User1\.openshift\express.conf ... done
57-
5860
----
5961

60-
61-
62-
63-
6462
*SSH Keys*
6563

66-
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.
67-
----
64+
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.
6865

66+
----
6967
No SSH keys were found. We will generate a pair of keys for you.
7068
Created: C:\Users\User1\.ssh\id_rsa.pub
71-
7269
----
7370

7471
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.
72+
7573
----
7674
Your public ssh key must be uploaded to the OpenShift server to access code.
7775
Upload now? (yes|no) yes
@@ -81,38 +79,28 @@ Since you do not have any keys associated with your OpenShift account, your new
8179
Uploading key 'default' from C:\Users\User1\.ssh\id_rsa.pub ... done
8280
----
8381

84-
85-
86-
87-
8882
*Installed Software*
8983

90-
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.
91-
----
84+
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.
9285

86+
----
9387
In order to fully interact with OpenShift you will need to install and configure a git client if you have not already done so.
9488
Documentation for installing other tools you will need for OpenShift can be found at https://openshift.redhat.com/community/developers/install-the-client-tools
9589
9690
We recommend these free applications:
9791
98-
9992
* Git for Windows - a basic git command line and GUI client https://github.com
10093
/msysgit/msysgit/wiki/InstallMSysGit
101-
94+
10295
* TortoiseGit - git client that integrates into the file explorer http://code.
10396
google.com/p/tortoisegit/
104-
10597
----
10698

107-
108-
109-
110-
11199
*Domain*
112100

113101
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.
114-
----
115102

103+
----
116104
Checking for a domain ... none
117105
118106
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.
@@ -121,26 +109,13 @@ Please enter a domain (letters and numbers only) |<none>|: MyDomain
121109
Your domain name 'MyDomain' has been successfully created
122110
----
123111

124-
125-
126-
127-
128-
129-
[IMPORTANT]
130-
====
131-
A domain must be created before you can create OpenShift applications.
132-
133-
134-
====
135-
112+
IMPORTANT: A domain must be created before you can create OpenShift applications.
136113

137114
*Applications*
138115

116+
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.
139117

140-
141-
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.
142118
----
143-
144119
Checking for applications ... none
145120
146121
Run 'rhc app create' to create your first application.
@@ -166,7 +141,6 @@ Run 'rhc app create' to create your first application.
166141
The following gear sizes are available to you: small
167142
168143
Your client tools are now configured.
169-
170144
----
171145

172-
The OpenShift client tools are now configured on your system.
146+
The OpenShift client tools are now configured on your system.

‎client_tools_install_guide/installing_client_tools_on_fedora.adoc‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
[[Installing_Client_Tools_on_Fedora]]
21
= Installing Client Tools on Fedora
2+
OpenShift Documentation Project <dev@lists.openshift.redhat.com>
3+
DOC_BRANCH_VERSION
4+
:data-uri:
5+
:icons:
36

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

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

19-
20-
2122
*Install with YUM Package Manager*
2223

2324
From the terminal, install the client tools and all other required dependencies:
25+
2426
----
2527
$ sudo yum install rubygem-rhc
2628
----
@@ -44,15 +46,17 @@ $ sudo gem install rhc
4446
*Automatic Completion Using the Tab Key*
4547

4648
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:
49+
4750
----
4851
$ rhc setup --autocomplete
4952
----
5053

5154
You may have to close your current terminal session, and open a new session to automatically source the bash completion script.
5255

5356
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:
57+
5458
----
5559
source /etc/bash_completion.d/rhc
5660
----
5761

58-
//When the installation completes, proceed to <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard.
62+
//When the installation completes, proceed to <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard.

‎client_tools_install_guide/installing_client_tools_on_macosx.adoc‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
[[Installing_Client_Tools_on_Mac_OS_X]]
21
= Installing Client Tools on Mac OS X
3-
2+
OpenShift Documentation Project <dev@lists.openshift.redhat.com>
3+
DOC_BRANCH_VERSION
4+
:data-uri:
45
:icons:
56

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

1718
== Install Ruby
1819

19-
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:
20+
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:
2021

2122
* Use the OS X installation CD
22-
23-
24-
* Download and install the link:$$https://developer.apple.com/xcode/$$[Xcode] integrated development environment from the Apple website
23+
* Download and install the https://developer.apple.com/xcode/[Xcode] integrated development environment from the Apple website
2524

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

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

3430
After Ruby is installed, run the following command to verify that it has installed correctly:
31+
3532
----
3633
$ ruby -e 'puts "Welcome to Ruby"'
3734
Welcome to Ruby
3835
----
3936

4037
== Install Git Version Control
4138

42-
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/$$[].
39+
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/
4340

4441
When the installation completes,, run the following command to verify that Git has installed correctly:
42+
4543
----
4644
$ git --version
4745
----
4846

49-
This command returns the Git version number that was installed.
47+
This command returns the Git version number that was installed.
5048

5149
== Install the Client Tools
5250

5351
When Ruby and Git have been successfully installed, run the following command to install the client tools:
52+
5453
----
5554
$ sudo gem install rhc
5655
----
56+
5757
//When the installation completes, proceed to <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard.

‎client_tools_install_guide/installing_client_tools_on_opensuse.adoc‎

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,16 @@
1-
[[Installing_Client_Tools_on_openSUSE]]
21
= Installing Client Tools on openSUSE
3-
2+
OpenShift Documentation Project <dev@lists.openshift.redhat.com>
3+
DOC_BRANCH_VERSION
4+
:data-uri:
45
:icons:
56

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

8-
*Step 1*: Install *_Ruby_*
9-
10-
11-
*Step 2*: Install *_RubyGems_*
12-
13-
14-
*Step 3*: Install *_Git_*
15-
9+
*Step 1*: Install *_Ruby_* +
10+
*Step 2*: Install *_RubyGems_* +
11+
*Step 3*: Install *_Git_* +
1612
*Step 4*: Install the client tools
1713

18-
19-
20-
2114
[NOTE]
2215
====
2316
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.
@@ -26,34 +19,36 @@ The +sudo+ command only works if the particular user is listed in the _sudoers_
2619
== Install Ruby
2720

2821
From terminal, run the following command to install Ruby:
22+
2923
----
3024
$ sudo zypper install ruby
3125
----
3226

3327
Run the following command to verify that Ruby has installed correctly:
28+
3429
----
3530
$ ruby -e 'puts "Welcome to Ruby"'
3631
Welcome to Ruby
3732
----
3833

39-
40-
41-
4234
== Install RubyGems
4335

4436
Run the following command to install RubyGems:
37+
4538
----
4639
$ sudo zypper install rubygems
4740
----
4841

4942
== Install Git
5043

5144
Run the following command to install Git version control:
45+
5246
----
5347
$ sudo zypper install git-core
5448
----
5549

5650
After installation completes, run the following command to verify that Git has installed correctly:
51+
5752
----
5853
$ git --version
5954
git version 1.7.11.1
@@ -65,8 +60,9 @@ This command returns the Git version number that was installed.
6560
== Install the Client Tools
6661

6762
When the required software has been successfully installed, run the following command to install the client tools:
63+
6864
----
6965
$ sudo gem install rhc
7066
----
7167

72-
//When the installation completes, proceed to <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard.
68+
//When the installation completes, proceed to <<Configuring_Client_Tools>> to configure the client tools using the interactive setup wizard.

0 commit comments

Comments
 (0)