Skip to content

Commit ee71367

Browse files
anarnold97anarnold97
authored
Merge branch 'main' into MTA-960_MTA-7-1-0-document-attributes
2 parents 02ec7b0 + 5dccbd4 commit ee71367

File tree

64 files changed

+1689
-255
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+1689
-255
lines changed

‎docs/cli-guide/master.adoc

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:mta:
22
include::topics/templates/document-attributes.adoc[]
3-
:_content-type: ASSEMBLY
3+
:_mod-docs-content-type: ASSEMBLY
44
[id="cli-guide"]
55
= CLI Guide
66

@@ -19,6 +19,12 @@ include::topics/making-open-source-more-inclusive.adoc[]
1919
// About the {UserCLIBookName}
2020
include::topics/about-cli-guide.adoc[leveloffset=+2]
2121

22+
:FeatureName: .NET migration
23+
include::topics/developer-preview-feature.adoc[]
24+
25+
:FeatureName: Analyzing applications written in a language other than Java
26+
include::topics/developer-preview-feature.adoc[]
27+
2228
// About {ProductName}
2329
include::topics/mta-what-is-the-toolkit.adoc[leveloffset=+2]
2430

@@ -34,11 +40,28 @@ include::topics/about-cli.adoc[leveloffset=+2]
3440
// Install the CLI
3541
include::topics/installing-cli-tool.adoc[leveloffset=+2]
3642

43+
// Install in disconnected environment
44+
include::topics/installing-mta-disconnected-environment.adoc[leveloffset=+2]
45+
3746
// CLI known issues
3847
include::topics/cli-tool-known-issues.adoc[leveloffset=+3]
3948

49+
[id="running-cli"]
50+
=== Running the CLI
51+
52+
You can run the {ProductFullName} {CLINameTitle} against one or more applications.
53+
54+
Before {ProductShortName} 7.1.0, if you wanted to run the {CLINameTitle} against multiple applications, you ran a series of `--analyze` commands, each against an application, and each generating a separate report. This option, which is still fully supported, is described in xref:mta-cli-run-single-app_cli-guide[Running the {ProductShortName} {CLINameTitle} against an application].
55+
56+
In {ProductShortName} 7.1.0 and later, you can run the {CLINameTitle} against multiple applications by using the `--bulk` option, to generate a single report. This option, which is presented as a Developer Preview, is described in xref:mta-cli-run-multiple-apps_cli-guide[Running the {ProductShortName} {CLINameTitle} against multiple applications and generating a single report (Developer Preview)].
57+
58+
:FeatureName: Running the {CLINameTitle} against one or more applications
59+
include::topics/developer-preview-feature.adoc[]
60+
4061
// Run the CLI
41-
include::topics/mta-cli-run.adoc[leveloffset=+2]
62+
include::topics/mta-cli-run-single-app.adoc[leveloffset=+3]
63+
64+
include::topics/mta-cli-run-multiple-apps.adoc[leveloffset=+3]
4265

4366
// Analyze application source code
4467
include::topics/mta-cli-analyze.adoc[leveloffset=+3]
@@ -55,6 +78,15 @@ include::topics/available-openrewrite-recipes.adoc[leveloffset=+4]
5578
// Access the Report
5679
include::topics/access-report.adoc[leveloffset=+2]
5780

81+
// Multi-language application analysis
82+
include::topics/mta-cli-analyze-multi-lang-apps.adoc[leveloffset=+2]
83+
84+
// Multi-language application analysis for the supported provider
85+
include::topics/mta-cli-analyze-selected-provider.adoc[leveloffset=+3]
86+
87+
// Multi-language application analysis for the unsupported provider
88+
include::topics/mta-cli-analyze-unsupported-provider.adoc[leveloffset=+3]
89+
5890
// Review the Reports
5991
include::topics/mta-review-reports.adoc[leveloffset=+1]
6092

@@ -102,3 +134,6 @@ include::topics/important-links.adoc[leveloffset=+3]
102134
// * Appendix: Revision Information *
103135
// **********************************
104136
include::topics/templates/revision-info.adoc[]
137+
138+
139+

‎docs/plugin-guide/topics

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../topics

‎docs/release-notes/master.adoc

Lines changed: 6 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -15,56 +15,15 @@ include::topics/making-open-source-more-inclusive.adoc[]
1515

1616
[id="release-notes-introduction"]
1717
== Introduction
18-
{ProductName} {DocInfoProductNumber} accelerates large-scale application modernization efforts across hybrid cloud environments on Red Hat OpenShift. This solution provides insight throughout the adoption process, at both the portfolio and application levels: inventory, assess, analyze, and manage applications for faster migration to OpenShift via the user interface.
18+
{ProductFullName} {DocInfoProductNumber} accelerates large-scale application modernization efforts across hybrid cloud environments on {ocp-first}. This solution provides insight throughout the adoption process, at both the portfolio and application levels: inventory, assess, analyze, and manage applications for faster migration to {ocp-short} through the user interface (UI) and command-line interface (CLI).
1919

20-
[id="mta-7-0-3"]
21-
== {ProductShortName} 7-0-3
20+
[id="mta-7-1-0"]
21+
== {ProductShortName} 7.1.0
2222

23-
include::topics/mta-rn-known-issues-7-0-3.adoc[leveloffset=+2]
23+
include::topics/ref_new-features-7-1-0.adoc[leveloffset=+2]
2424

25-
include::topics/cli-tool-known-issues-703.adoc[leveloffset=+3]
25+
include::topics/ref_upgrade-notes-7-1-0.adoc[leveloffset=+2]
2626

27-
include::topics/mta-rn-resolved-issues-7-0-3.adoc[leveloffset=+2]
28-
29-
30-
[id="mta-7-0-2"]
31-
== {ProductShortName} 7-0-2
32-
33-
include::topics/mta-rn-new-features-7-0-2.adoc[leveloffset=+2]
34-
35-
include::topics/mta-rn-known-issues-7-0-2.adoc[leveloffset=+2]
36-
37-
include::topics/cli-tool-known-issues-702.adoc[leveloffset=+3]
38-
39-
include::topics/mta-rn-resolved-issues-7-0-2.adoc[leveloffset=+2]
40-
41-
include::topics/mta-rn-upgrade-notes-7-0-2.adoc[leveloffset=+2]
42-
43-
44-
[id="mta-7-0-1"]
45-
== {ProductShortName} 7-0-1
46-
47-
include::topics/mta-rn-known-issues-7-0-1.adoc[leveloffset=+2]
48-
49-
include::topics/cli-tool-known-issues-701.adoc[leveloffset=+3]
50-
51-
include::topics/mta-rn-resolved-issues-7-0-1.adoc[leveloffset=+2]
52-
53-
include::topics/mta-rn-upgrade-notes-7-0-1.adoc[leveloffset=+2]
54-
55-
56-
57-
[id="mta-7-0-0"]
58-
== {ProductShortName} 7-0-0
59-
60-
include::topics/mta-rn-new-features-7-0-0.adoc[leveloffset=+2]
61-
62-
include::topics/mta-rn-known-issues-7-0-0.adoc[leveloffset=+2]
63-
64-
include::topics/mta-rn-resolved-issues-7-0-0.adoc[leveloffset=+2]
65-
66-
include::topics/mta-rn-upgrade-notes-7-0-0.adoc[leveloffset=+2]
67-
68-
include::topics/mta-rn-technical-changes-7-0-0.adoc[leveloffset=+2]
27+
include::topics/ref_known-issues-7-1-0.adoc[leveloffset=+2]
6928

7029
:!release-notes:

‎docs/topics/about-cli-guide.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
[id="about-cli-guide_{context}"]
77
= About the {UserCLIBookName}
88

9-
This guide is for engineers, consultants, and others who want to use the {ProductName} ({ProductShortName}) to migrate Java applications or other components. It describes how to install and run the {CLIName}, review the generated reports, and take advantage of additional features.
9+
This guide is for engineers, consultants, and others who want to use the {ProductName} ({ProductShortName}) to migrate Java applications, .NET applications, or other components. In {ProductShortName} 7.1 and later, you can use {ProductShortName} to analyze applications written in languages other than Java. To run analysis on applications written in languages other than Java, add a custom rule set and do not specify a target language. This guide describes how to install and run the {CLIName}, review the generated reports, and take advantage of additional features.

‎docs/topics/accessing-unmatched-rules.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/web-console-guide/master.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="accessing-unmatched-rules_{context}"]
7+
= Accessing unmatched rules
8+
9+
To access unmatched rules, you must run the analysis with enhanced logging enabled.
10+
11+
. Navigate to *Advanced* under *Application analysis*.
12+
. Select *Options*.
13+
. Check *Enhanced advanced analysis details*.
14+
15+
When you run an analysis:
16+
17+
. Navigate to *Reports* in the side drawer.
18+
. Click *View analysis details*, which opens the YAML/JSON format log view.
19+
. Select the `issues.yaml` file.
20+
. For each ruleset, there is an *unmatched* section that lists the rule IDs that do not find match rules.
21+
+
22+
image::unmatched-rules.png[unmatched rule IDs in issues.yaml]

‎docs/topics/con_automatic-tagging-of-an-application.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
[role="_abstract"]
1010

11-
{ProductShortName} can automatically add tags to the application based on the application analysis. Automatic tagging is especially useful when dealing with large portfolios of applications.
11+
{ProductShortName} automatically spawns language discovery and technology discovery tasks when adding an application to the *Application Inventory*. When the language discovery task is running, the technology discovery and analysis tasks wait until the language discovery task is finished. These tasks automatically add tags to the application. {ProductShortName} can automatically add tags to the application based on the application analysis. Automatic tagging is especially useful when dealing with large portfolios of applications.
1212

13-
Automatic tagging of applications is enabled by default. You can disable automatic tagging by deselecting the *Enable automated tagging* checkbox in the *Advanced* section of the *Analysis configuration* wizard.
13+
Automatic tagging of applications based on application analysis is enabled by default. You can disable automatic tagging during application analysis by deselecting the *Enable automated tagging* checkbox in the *Advanced* section of the *Analysis configuration* wizard.
1414

1515
NOTE: To tag an application automatically, make sure that the *Enable automated tagging* checkbox is selected _before_ you run an application analysis.

‎docs/topics/create-first-yaml-rule.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// * docs/rules-development-guide/master.adoc
44

5-
:_content-type: PROCEDURE
5+
:_mod-docs-content-type: PROCEDURE
66
[id="create-first-yaml-rule_{context}"]
77
= Creating your first YAML rule
88

@@ -13,7 +13,7 @@ In this example, you will create a rule to discover instances where an applicati
1313
[id="creating-yaml-file-for-the-rule_{context}"]
1414
== Creating a YAML file for the rule
1515

16-
Create a YAML file for your first rule.
16+
* Create a YAML file for your first rule.
1717

1818
[options="nowrap",subs="attributes+"]
1919
----
@@ -82,7 +82,7 @@ when(condition)
8282

8383
.Procedure
8484

85-
. In the `rule.yaml` file you created, paste the following contents:
85+
* In the `rule.yaml` file you created, paste the following contents:
8686
+
8787
[options="nowrap",subs="attributes+"]
8888
----
@@ -97,10 +97,10 @@ when(condition)
9797
- <LINKS> <7>
9898
----
9999
+
100-
<1> Unique ID for your rule, for instance, `jboss5-web-class-loading`.
100+
<1> Unique ID for your rule. For example, `jboss5-web-class-loading`.
101101
<2> Text description of the rule.
102102
<3> Complete the `when` block specifying one or more conditions:
103-
.. Use the `builtin` provider’s XML capability because this rule checks for a match in an XML file.
103+
.. Use the `builtin` provider's XML capability because this rule checks for a match in an XML file.
104104
.. To match on the `class-loading` element that is a child of `jboss-web`, use the XPath expression `jboss-web/web-loading` as an XML query. In this case, you need just one condition:
105105
+
106106
[options="nowrap",subs="attributes+"]
@@ -146,7 +146,7 @@ The rule is now complete and looks similar to the following:
146146
== Installing the rule
147147

148148
.Procedure
149-
. Point the CLI to the rule file you created :
149+
* Point the CLI to the rule file you created :
150150
+
151151
[options="nowrap",subs="attributes+"]
152152
----

‎docs/topics/create-yaml-rule.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// * docs/rules-development-guide/master.adoc
44

5-
:_content-type: PROCEDURE
5+
:_mod-docs-content-type: PROCEDURE
66
[id="create-yaml-rule_{context}"]
77
= Creating a YAML rule
88

@@ -125,7 +125,7 @@ The table below lists all available providers, their capabilities, and their fie
125125
|Yes
126126
|Finds files with names matching this pattern
127127
|`hasTags`
128-
3+>|This is an inline list of string tags. See _Tag Action_ for details on tag format.
128+
3+^| This is an inline list of string tags. See *Tag Actions* in xref:yaml-rule-actions_{context}[Rule Actions] for details on tag format.
129129

130130
.5+.^|`go`
131131
|`referenced`

‎docs/topics/developer-preview-feature.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// DO NOT USE THIS SNIPPET. DEVELOPER PREVIEW FEATURES ARE NOT DOCUMENTED IN CORE OPENSHIFT DOCS.
2+
3+
// When including this file, ensure that {FeatureName} is set immediately before the include. Otherwise it will result in an incorrect replacement.
4+
5+
[IMPORTANT]
6+
====
7+
[subs="attributes+"]
8+
{FeatureName} is a Developer Preview feature only. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to upcoming product features in advance of their possible inclusion in a Red Hat product offering, enabling customers to test functionality and provide feedback during the development process. These features might not have any documentation, are subject to change or removal at any time, and testing is limited. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
9+
====
10+
// Undefine {FeatureName} attribute, so that any mistakes are easily spotted
11+
:!FeatureName:

‎docs/topics/images/mta-cli-guide-app-insights.png

65.6 KB
Loading

0 commit comments

Comments
 (0)