Skip to content

Commit 2dd7715

Browse files
authored
Merge pull request #42769 from sagidlow/OSDOCS-2691-fixes
OSDOCS-2691: Fixing some post merge typos and style guide issues
2 parents 59e4a77 + 0a7061d commit 2dd7715

26 files changed

+223
-215
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Topics:
5858
Dir: getting_started
5959
Distros: openshift-enterprise
6060
Topics:
61-
- Name: Overview
61+
- Name: OpenShift Container Platform overview
6262
File: openshift-overview
6363
- Name: Web console walkthrough
6464
File: openshift-web-console

getting_started/openshift-cli.adoc

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,73 @@ toc::[]
1212

1313
* Review xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-about-cli_cli-developer-commands[About the OpenShift CLI].
1414
* You must be able to access a running instance of {product-title}. If you do not have access, contact your cluster administrator.
15-
* You must have the OpenShift Container Platform CLI (oc) xref:../cli_reference/openshift_cli/getting-started-cli.adoc#installing-openshift-cli[downloaded and installed].
15+
* You must have the OpenShift CLI (`oc`) xref:../cli_reference/openshift_cli/getting-started-cli.adoc#installing-openshift-cli[downloaded and installed].
1616

1717
include::modules/getting-started-cli-login.adoc[leveloffset=+1]
18+
[role="_additional-resources"]
19+
.Additional resources
20+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-login[oc login]
21+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-logout[oc logout]
22+
1823
include::modules/getting-started-cli-creating-new-project.adoc[leveloffset=+1]
24+
[role="_additional-resources"]
25+
.Additional resources
26+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-new-project[oc new-project]
27+
1928
include::modules/getting-started-cli-granting-permissions.adoc[leveloffset=+1]
29+
[role="_additional-resources"]
30+
.Additional resources
31+
* xref:../authentication/understanding-authentication.adoc#understanding-authentication[Understanding authentication]
32+
* xref:../authentication/using-rbac.adoc#authorization-overview_using-rbac[RBAC overview]
33+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-policy-add-role-to-user[oc policy add-role-to-user]
34+
2035
include::modules/getting-started-cli-deploying-first-image.adoc[leveloffset=+1]
36+
[role="_additional-resources"]
37+
.Additional resources
38+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-new-app[oc new-app]
39+
40+
2141
include::modules/getting-started-cli-creating-route.adoc[leveloffset=+2]
42+
[role="_additional-resources"]
43+
.Additional resources
44+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-create-route-edge[oc create route edge]
45+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-get[oc get]
46+
47+
2248
include::modules/getting-started-cli-examining-pod.adoc[leveloffset=+2]
49+
[role="_additional-resources"]
50+
.Additional resources
51+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-describe[oc describe]
52+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-get[oc get]
53+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-label[oc label]
54+
* xref:../cli_reference/openshift_cli/getting-started-cli.adoc#viewing-pods[Viewing pods]
55+
* xref:../cli_reference/openshift_cli/getting-started-cli.adoc#viewing-pod-logs[Viewing pod logs]
56+
2357
include::modules/getting-started-cli-scaling-app.adoc[leveloffset=+2]
58+
[role="_additional-resources"]
59+
.Additional resources
60+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-scale[oc scale]
61+
2462
include::modules/getting-started-cli-deploying-python-app.adoc[leveloffset=+1]
63+
[role="_additional-resources"]
64+
.Additional resources
65+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-new-app[oc new-app]
66+
2567
include::modules/getting-started-cli-connecting-a-database.adoc[leveloffset=+1]
68+
[role="_additional-resources"]
69+
.Additional resources
70+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-new-project[oc new-project]
71+
2672
include::modules/getting-started-cli-creating-secret.adoc[leveloffset=+2]
73+
[role="_additional-resources"]
74+
.Additional resources
75+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-create-secret-generic[oc create secret generic]
76+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-set-env[oc set env]
77+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-rollout-status[oc rollout status]
78+
2779
include::modules/getting-started-cli-load-data-output.adoc[leveloffset=+2]
80+
[role="_additional-resources"]
81+
.Additional resources
82+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-exec[oc exec]
83+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-label[oc label]
84+
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-get[oc get]

getting_started/openshift-overview.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: ASSEMBLY
22
[id="openshift-overview"]
3-
= Overview
3+
= {product-title} overview
44
include::_attributes/common-attributes.adoc[]
55
:context: openshift-overview
66

@@ -11,8 +11,8 @@ toc::[]
1111
{product-title} enables you to do the following:
1212

1313
* Provide developers and IT organizations with cloud application platforms that can be used for deploying applications on secure and scalable resources.
14-
* Require minimal configuration and management overhead. {product-title} is built on Kubernetes.
15-
* Bring Kubernetes platform to customer data centers and cloud.
14+
* Require minimal configuration and management overhead.
15+
* Bring the Kubernetes platform to customer data centers and cloud.
1616
* Meet security, privacy, compliance, and governance requirements.
1717
1818
With its foundation in Kubernetes, {product-title} incorporates the same technology that serves as the engine for massive telecommunications, streaming video, gaming, banking, and other applications. Its implementation in open Red Hat technologies lets you extend your containerized applications beyond a single cloud to on-premise and multi-cloud environments.
@@ -24,10 +24,10 @@ include::modules/getting-started-openshift-common-terms.adoc[leveloffset=+1]
2424

2525
The {product-title} installation program offers you flexibility. You can use the installation program to deploy a cluster on infrastructure that the installation program provisions and the cluster maintains or deploy a cluster on infrastructure that you prepare and maintain.
2626

27-
For more information about the installation process is, the supported platforms, and choosing a method of installing and preparing your cluster, see the following:
27+
For more information about the installation process, the supported platforms, and choosing a method of installing and preparing your cluster, see the following:
2828

2929
* xref:../installing/index.adoc#installation-overview_ocp-installation-overview[OpenShift Container Platform installation overview]
30-
* xref:../installing/index.adoc#installation-process_ocp-installation-overview[Installation overview]
30+
* xref:../installing/index.adoc#installation-process_ocp-installation-overview[Installation process]
3131
* xref:../installing/index.adoc#supported-platforms-for-openshift-clusters_ocp-installation-overview[Supported platforms for OpenShift Container Platform clusters]
3232
* xref:../installing/installing-preparing.adoc#installing-preparing-selecting-cluster-type[Selecting a cluster installation type]
3333

getting_started/openshift-web-console.adoc

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,72 @@ toc::[]
99
[id="openshift-web-console-before-you-begin"]
1010

1111
== Before you begin
12-
* Review xref:../web_console/web-console.adoc#web-console-overview[accessing the web console].
12+
* Review xref:../web_console/web-console.adoc#web-console-overview[Accessing the web console].
1313
* You must be able to access a running instance of {product-title}. If you do not have access, contact your cluster administrator.
1414

1515
include::modules/getting-started-web-console-login.adoc[leveloffset=+1]
16+
1617
include::modules/getting-started-web-console-creating-new-project.adoc[leveloffset=+1]
18+
[role="_additional-resources"]
19+
.Additional resources
20+
* xref:../authentication/using-rbac.adoc#default-roles_using-rbac[Default cluster roles]
21+
* xref:../applications/projects/working-with-projects.adoc#viewing-a-project-using-the-web-console_projects[Viewing a project using the web console]
22+
* xref:../applications/projects/working-with-projects.adoc#odc-providing-project-permissions-using-developer-perspective_projects[Providing access permissions to your project using the Developer perspective]
23+
* xref:../applications/projects/working-with-projects.adoc#deleting-a-project-using-the-web-console_projects[Deleting a project using the web console]
24+
1725
include::modules/getting-started-web-console-granting-permissions.adoc[leveloffset=+1]
26+
[role="_additional-resources"]
27+
.Additional resources
28+
* xref:../authentication/understanding-authentication.adoc#rbac-users_understanding-authentication[Understanding authentication]
29+
* xref:../authentication/using-rbac.adoc#authorization-overview_using-rbac[RBAC overview]
30+
1831
include::modules/getting-started-web-console-deploying-first-image.adoc[leveloffset=+1]
32+
[role="_additional-resources"]
33+
.Additional resources
34+
* xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc[Creating applications using the Developer perspective]
35+
* xref:../applications/projects/working-with-projects.adoc#viewing-a-project-using-the-web-console_projects[Viewing a project using the web console]
36+
* xref:../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-viewing-application-topology_viewing-application-composition-using-topology-view[Viewing the topology of your application]
37+
* xref:../applications/projects/working-with-projects.adoc#deleting-a-project-using-the-web-console_projects[Deleting a project using the web console]
38+
1939
include::modules/getting-started-web-console-examining-pod.adoc[leveloffset=+2]
40+
[role="_additional-resources"]
41+
.Additional resources
42+
* xref:../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-interacting-with-applications-and-components_viewing-application-composition-using-topology-view[Interacting with applications and components]
43+
* xref:../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-scaling-application-pods-and-checking-builds-and-routes_viewing-application-composition-using-topology-view[Scaling application pods and checking builds and routes]
44+
* xref:../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-labels-and-annotations-used-for-topology-view_viewing-application-composition-using-topology-view[Labels and annotations used for the Topology view]
45+
2046
include::modules/getting-started-web-console-scaling-app.adoc[leveloffset=+2]
47+
[role="_additional-resources"]
48+
.Additional resources
49+
* xref:../scalability_and_performance/recommended-cluster-scaling-practices.adoc#recommended-scale-practices_cluster-scaling[Recommended practices for scaling the cluster]
50+
* xref:../nodes/pods/nodes-pods-autoscaling.adoc#nodes-pods-autoscaling-about_nodes-pods-autoscaling[Understanding horizontal pod autoscalers]
51+
* xref:../nodes/pods/nodes-pods-vertical-autoscaler.adoc#nodes-pods-vertical-autoscaler-about_nodes-pods-vertical-autoscaler[About the Vertical Pod Autoscaler Operator]
52+
2153
include::modules/getting-started-web-console-deploying-python-app.adoc[leveloffset=+1]
54+
[role="_additional-resources"]
55+
.Additional resources
56+
* xref:../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-adding-services-to-your-application_viewing-application-composition-using-topology-view[Adding services to your application]
57+
* xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-importing-codebase-from-git-to-create-application_odc-creating-applications-using-developer-perspective[Importing a codebase from Git to create an application]
58+
* xref:../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-viewing-application-topology_viewing-application-composition-using-topology-view[Viewing the topology of your application]
59+
* xref:../applications/projects/working-with-projects.adoc#odc-providing-project-permissions-using-developer-perspective_projects[Providing access permissions to your project using the Developer perspective]
60+
* xref:../applications/projects/working-with-projects.adoc#deleting-a-project-using-the-web-console_projects[Deleting a project using the web console]
61+
2262
include::modules/getting-started-web-console-connecting-a-database.adoc[leveloffset=+1]
63+
[role="_additional-resources"]
64+
.Additional resources
65+
* xref:../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-adding-services-to-your-application_viewing-application-composition-using-topology-view[Adding services to your application]
66+
* xref:../applications/projects/working-with-projects.adoc#viewing-a-project-using-the-web-console_projects[Viewing a project using the web console]
67+
* xref:../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-viewing-application-topology_viewing-application-composition-using-topology-view[Viewing the topology of your application]
68+
* xref:../applications/projects/working-with-projects.adoc#odc-providing-project-permissions-using-developer-perspective_projects[Providing access permissions to your project using the Developer perspective]
69+
* xref:../applications/projects/working-with-projects.adoc#deleting-a-project-using-the-web-console_projects[Deleting a project using the web console]
70+
2371
include::modules/getting-started-web-console-creating-secret.adoc[leveloffset=+2]
72+
[role="_additional-resources"]
73+
.Additional resources
74+
* xref:../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets-about_nodes-pods-secrets[Understanding secrets]
75+
2476
include::modules/getting-started-web-console-load-data-output.adoc[leveloffset=+2]
77+
[role="_additional-resources"]
78+
.Additional resources
79+
* xref:../applications/projects/working-with-projects.adoc#odc-providing-project-permissions-using-developer-perspective_projects[Providing access permissions to your project using the Developer perspective]
80+
* xref:../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-labels-and-annotations-used-for-topology-view_viewing-application-composition-using-topology-view[Labels and annotations used for the Topology view]

modules/getting-started-cli-connecting-a-database.adoc

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= Connecting to a database
88

99
Deploy and connect a MongoDB database where the `national-parks-app` application stores location information.
10-
Once you mark the `national-parks-app` application as a backend for the map visualization tool, `parksmap` deployment uses {product-title} discover mechanism to display the map automatically.
10+
Once you mark the `national-parks-app` application as a backend for the map visualization tool, `parksmap` deployment uses the {product-title} discover mechanism to display the map automatically.
1111

1212
.Prerequisites
1313

@@ -17,7 +17,7 @@ Once you mark the `national-parks-app` application as a backend for the map visu
1717
1818
.Procedure
1919

20-
. To connect to a database, enter the following command:
20+
* To connect to a database, enter the following command:
2121
+
2222
[source,terminal]
2323
----
@@ -44,7 +44,3 @@ $ oc new-app quay.io/centos7/mongodb-36-centos7 --name mongodb-nationalparks -e
4444
service "mongodb-nationalparks" created
4545
--> Success
4646
----
47-
48-
[role="_additional-resources"]
49-
.Additional resources
50-
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-new-project[oc new-project]

modules/getting-started-cli-creating-new-project.adoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,3 @@ $ oc new-project user-getting-started --display-name="Getting Started with OpenS
3232
----
3333
Now using project "user-getting-started" on server "https://openshift.example.com:6443".
3434
----
35-
36-
[role="_additional-resources"]
37-
.Additional resources
38-
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-new-project[oc new-project]

modules/getting-started-cli-creating-route.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,3 @@ $ oc get route
6262
NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD
6363
parksmap parksmap-user-getting-started.apps.cluster.example.com parksmap 8080-tcp edge None
6464
----
65-
66-
[role="_additional-resources"]
67-
.Additional resources
68-
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-create-route-edge[oc create route edge]
69-
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-get[oc get]

modules/getting-started-cli-creating-secret.adoc

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
= Creating a secret
99

10-
The `Secret` object type provides a mechanism to hold sensitive information such as passwords, {product-title} client configuration files, private source repository credentials, and so on.
10+
The `Secret` object provides a mechanism to hold sensitive information such as passwords, {product-title} client configuration files, private source repository credentials, and so on.
1111
Secrets decouple sensitive content from the pods. You can mount secrets into containers using a volume plug-in or the system can use secrets to perform actions on behalf of a pod.
1212
The following procedure adds the secret `nationalparks-mongodb-parameters` and mounts it to the `nationalparks` workload.
1313

@@ -47,11 +47,24 @@ $ oc set env --from=secret/nationalparks-mongodb-parameters deploy/nationalparks
4747
deployment.apps/nationalparks updated
4848
----
4949

50-
. To show the status of the rollout, enter the following command:
50+
. To show the status of the `nationalparks` deployment, enter the following command:
5151
+
5252
[source,terminal]
5353
----
5454
$ oc rollout status deployment nationalparks
55+
----
56+
+
57+
.Example output
58+
+
59+
[source,terminal]
60+
----
61+
deployment "nationalparks" successfully rolled out
62+
----
63+
64+
. To show the status of the `mongodb-nationalparks` deployment, enter the following command:
65+
+
66+
[source,terminal]
67+
----
5568
$ oc rollout status deployment mongodb-nationalparks
5669
----
5770
+
@@ -62,9 +75,3 @@ $ oc rollout status deployment mongodb-nationalparks
6275
deployment "nationalparks" successfully rolled out
6376
deployment "mongodb-nationalparks" successfully rolled out
6477
----
65-
66-
[role="_additional-resources"]
67-
.Additional resources
68-
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-create-secret-generic[oc create secret generic]
69-
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-set-env[oc set env]
70-
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-rollout-status[oc rollout status]

modules/getting-started-cli-deploying-first-image.adoc

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="getting-started-cli-deploying-first-image_{context}"]
77
= Deploying your first image
88

9-
The simplest way to deploy an application in {product-title} is to run an existing container image. The following procedure deploys a front end component of an application called `national-parks-app`. The web application displays an interactive map. The map displays the location of major national parks across the world.
9+
The simplest way to deploy an application in {product-title} is to run an existing container image. The following procedure deploys a front-end component of an application called `national-parks-app`. The web application displays an interactive map. The map displays the location of major national parks across the world.
1010

1111
.Prerequisites
1212

@@ -35,8 +35,3 @@ $ oc new-app quay.io/openshiftroadshow/parksmap:latest --name=parksmap -l 'app=n
3535
service "parksmap" created
3636
--> Success
3737
----
38-
39-
[role="_additional-resources"]
40-
.Additional resources
41-
42-
* xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-new-app[oc new-app]

0 commit comments

Comments
 (0)