Skip to content

Commit 02b8a93

Browse files
authored
Merge pull request #229 from anarnold97/MTA-6216-Misformatting-in-the-Install-Guide
MTA-6216: Misformatting in the Install Guide
2 parents 7877fd2 + a36c51e commit 02b8a93

File tree

4 files changed

+25
-25
lines changed

4 files changed

+25
-25
lines changed

docs/topics/mta-cli/ref_contributing-to-mta-development.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
= Contributing to the {ProductShortName} project
99

1010
[role="_abstract"]
11-
You can help the {ProductName} to cover most application constructs and server configurations, including yours.
11+
You can help the {ProductName} to cover most application constructs and server configurations, including yours.
1212

1313
You can provide your help with any of the following items:
1414

@@ -18,7 +18,7 @@ You can provide your help with any of the following items:
1818
** Write a short description of the problem migration areas.
1919
** Write a brief overview describing how to solve the problem in migration areas.
2020
* Try {ProductName} on your application. Make sure to report any issues you meet.
21-
* Try {ProductName} on your application. Make sure to report any issues you meet.{ProductShortName} uses Jira as its issue tracking system. If you encounter an issue executing {ProductShortName}, submit a link:{JiraWindupURL}[Jira issue].
21+
* Try {ProductName} on your application. Make sure to report any issues you meet. {ProductShortName} uses Jira as its issue tracking system. If you encounter an issue executing {ProductShortName}, submit a link:{JiraWindupURL}[Jira issue].
2222
* Contribute to the {ProductName} rules repository:
2323
** Write a {ProductName} rule to identify or automate a migration process.
2424
** Create a test for the new rule.
@@ -34,4 +34,4 @@ For more information, see link:{ProductDocRulesGuideURL}[_{RulesDevBookName}_].
3434

3535
* link:https://developer.jboss.org/en/windup[{ProductShortName} forums]
3636
* link:https://issues.redhat.com/projects/MTA/issues/MTA-4961?filter=allopenissues[Jira issues tracker]
37-
Any level of involvement is greatly appreciated!
37+
Any level of involvement is greatly appreciated!

docs/topics/mta-install/proc_creating-mta-instance.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:_mod-docs-content-type: PROCEDURE
44

55
[id="creating-mta-instance_{context}"]
6-
= Creating a MTA instance
6+
= Creating an MTA instance
77

88
[role="_abstract"]
99
You can use the {ProductFullName} user interface (UI) to assess and analyze your applications to get insights about the adoption process at both the portfolio and application levels as you inventory, assess, analyze, and manage applications for faster migration to Red Hat OpenShift.
@@ -13,19 +13,19 @@ To use the {ProductShortName} UI for assessing and analyzing your applications,
1313
.Prerequisites
1414

1515
* You installed the {ProductShortName} Operator on your system. For more information, see xref:installing-mta-operator_installing-mta-ui[Installing the Migration Toolkit for Applications Operator].
16-
* 4 vCPUs, 8 GB RAM, and 40 GB persistent storage.
17-
* Any cloud services or self-hosted edition of Red Hat OpenShift on versions 4.13-4.15.
18-
* You are logged in as a user with `cluster-admin` permissions.
16+
* 4 vCPUs, 8 GB RAM, and 40 GB persistent storage.
17+
* Any cloud services or self-hosted edition of Red Hat OpenShift on versions 4.13-4.15.
18+
* You are logged in as a user with `cluster-admin` permissions.
1919

2020

2121
.Procedure
22-
. Click *MTA Operator*.
23-
. Under *Provided APIs*, search for *Tackle* and click *Create Instance*.
24-
. Access the user interface from your browser by using the route exposed by the `mta-ui` application within OpenShift.
22+
. Click *MTA Operator*.
23+
. Under *Provided APIs*, search for *Tackle* and click *Create Instance*.
24+
. Access the user interface from your browser by using the route exposed by the `mta-ui` application within OpenShift.
2525
. Log in to the user interface instance by using the default credentials:
2626
** User name: `admin`
2727
** Password: `Passw0rd!`
28-
. When prompted, create a new password.
28+
. When prompted, create a new password.
2929

3030

3131
[role="_additional-resources"]

docs/topics/mta-install/proc_installing-mta-operator.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,30 @@
66
= Installing the {ProductShortName} Operator
77

88
[role="_abstract"]
9-
To create {ProductFullName} instances, you must first install the {ProductShortName} Operator.
9+
To create {ProductFullName} instances, you must first install the {ProductShortName} Operator.
1010

11-
The {ProductShortName} Operator is a structural layer that manages resources deployed on OpenShift, such as database, front end, and back end, to automatically create an {ProductShortName} instance.
11+
The {ProductShortName} Operator is a structural layer that manages resources deployed on OpenShift, such as the database, front end, and back end, to automatically create an {ProductShortName} instance.
1212

1313
.Prerequisites
1414

15-
* 4 vCPUs, 8 GB RAM, and 40 GB persistent storage.
15+
* 4 vCPUs, 8 GB RAM, and 40 GB persistent storage.
1616
* Any cloud services or self-hosted edition of Red Hat OpenShift on versions 4.13-4.15.
17-
* 2 RWO persistent volumes (PVs) used by different components. For more information, see xref:[Persistent volume requirements].
18-
* You are logged in as a user with `cluster-admin` permissions.
17+
* 2 RWO persistent volumes (PVs) used by different components. For more information, see link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#persistent-volume-requirements_installing-mta-ui[Persistent volume requirements].
18+
* You are logged in as a user with `cluster-admin` permissions.
1919

2020

2121
.Procedure
2222

23-
. In the Red Hat OpenShift web console, click *Operators* and then click *OperatorHub*.
24-
. Type _{ProductShortName}_ in the *Filter by keyword* field to search for the {ProductShortName} Operator.
25-
. Click the {ProductName} Operator and then click *Install*.
26-
. On the *Install Operator* page, click *Install*.
23+
. In the Red Hat OpenShift web console, click *Operators* and then click *OperatorHub*.
24+
. Type _{ProductShortName}_ in the *Filter by keyword* field to search for the {ProductShortName} Operator.
25+
. Click the {ProductName} Operator and then click *Install*.
26+
. On the *Install Operator* page, click *Install*.
2727
. Optional: Review and edit the custom resource (CR) settings.
2828
+
2929
A window for creating CR settings opens automatically after the installation of MTA Operator is complete. The default settings are acceptable. However, make sure to check the system requirements for storage, memory, and cores.
3030
+
3131
Alternatively, to work directly with the YAML file, click the *YAML* view and review the CR settings that are listed in the spec section of the YAML file. For more details about commonly used CR settings, see xref:custom-resource-settings_installing-mta-ui[Custom resource settings].
32-
+
32+
+
3333
The `spec` section of the YAML file can have the following configuration:
3434
+
3535
[subs="+quotes"]
@@ -44,11 +44,11 @@ spec:
4444
maven_data_volume_size: "2.5Gi"
4545
rwx_supported: "false"
4646
----
47-
. Verify that the MTA pods are running by clicking *Workloads* and then *Pods* in the *Administration* view.
47+
. Verify that the MTA pods are running by clicking *Workloads* and then *Pods* in the *Administration* view.
4848

4949
.Verification
5050

51-
* Verify that the MTA Operator appears in the `openshift-mta` project with the status *Succeeded* by clicking *Operators* and then *Installed Operators*.
51+
* Verify that the MTA Operator appears in the `openshift-mta` project with the status *Succeeded* by clicking *Operators* and then *Installed Operators*.
5252

5353
[role="_additional-resources"]
5454
.Next steps

docs/topics/mta-install/ref_persistent-volume-requirements.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= Persistent volume requirements
88

99
[role="_abstract"]
10-
To successfully deploy, the {ProductShortName} Operator requires two ReadWriteOnce (RWO) persistent volumes (PVs) used by different components. If the `rwx_supported` configuration option is set to `true`, the {ProductShortName} Operator requires additional two ReadWriteMany (RWX) PVs that are used by Maven and the hub file storage.
10+
To successfully deploy, the {ProductShortName} Operator requires two ReadWriteOnce (RWO) persistent volumes (PVs) used by different components. If the `rwx_supported` configuration option is set to `true`, the {ProductShortName} Operator requires two additional ReadWriteMany (RWX) PVs that are used by Maven and the hub file storage.
1111

1212
.Required persistent volumes
1313
[cols="25%,25%,25%,25%", options="header"]
@@ -30,7 +30,7 @@ To successfully deploy, the {ProductShortName} Operator requires two ReadWriteOn
3030
|`keycloak postgresql`
3131
|`1Gi`
3232
|RWO
33-
|Keycloak back end database
33+
|Keycloak backend database
3434

3535
|`cache`
3636
|`100Gi`

0 commit comments

Comments
 (0)