Skip to content

Commit afd0bc8

Browse files
committed
[TAAP-2969] Style edits
1 parent c11b43b commit afd0bc8

6 files changed

+45
-44
lines changed

tap-gui/plugins/app-live-view-springcloudgateway.hbs.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,16 @@ option from the **Information Category** drop-down menu.
3333

3434
The API Authentications By Path page displays the total requests, number of successes, and forbidden
3535
and unsuccessful authentications grouped by the HTTP method and gateway route path.
36-
The page also displays the success rate for each of the routes.
36+
The page also displays the success rate for each route.
3737

3838
![API Authentications By Path Page in the UI. The table gives information including numbers for requests, successes, and forbidden errors.](images/api-authentications-by-path.png)
3939

4040
> **Note** In addition to the preceding three pages, the Spring Boot actuator pages are also displayed.
4141
4242
## <a id="troubleshooting"></a> Troubleshooting
4343

44-
You might run into cases where a workload running on your cluster does not show up in the
45-
Application Live View overview, or the detail pages do not load any information while running,
46-
or other similar issues.
47-
For more information, see [Troubleshooting](../../app-live-view/troubleshooting.md) in the
48-
Application Live View documentation.
44+
You might run into cases where a workload running on your cluster does not appear in the Application
45+
Live View overview, or the detail pages do not load any information while running, or other similar
46+
issues.
47+
For more information about such issues, see [Troubleshooting](../../app-live-view/troubleshooting.hbs.md)
48+
in the Application Live View documentation.

tap-gui/plugins/app-live-view-steeltoe.hbs.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ menu.
3333
The health page provides detailed information about the health of the application.
3434
It lists all the components that make up the health of the application, such as readiness, liveness,
3535
and disk space.
36-
It displays the status and details associated with each of the components.
36+
It displays the status and details associated with each component.
3737

3838
![Health Page in the UI showing information such as readiness, disk space, and liveness.](images/health-steeltoe.png)
3939

@@ -44,30 +44,30 @@ To access the **Environment** page, select the **Environment** option from the
4444

4545
The Environment page contains details of the applications' environment.
4646
It contains properties including, but not limited to, system properties, environment variables, and
47-
configuration properties (such as appsettings.json) in a Steeltoe application.
47+
configuration properties (such as `appsettings.json`) in a Steeltoe application.
4848

4949
The page includes the following capabilities for `viewing` configured environment properties:
5050

51-
- The UI has a search feature that enables the user to search for a property or values.
52-
- Each property has a search icon at the right corner which helps the user quickly see all the
51+
- The UI has a search feature that enables you to search for a property or values.
52+
- Each property has a search icon at the right corner which helps you quickly see all the
5353
occurrences of a specific property key without manually typing in the search box.
5454
Clicking the search button locates the property name.
5555
- The **Refresh Scope** button on the top right corner of the page probes the application to refresh
5656
all the environment properties.
5757

5858
The page also includes the following capabilities for `editing` configured environment properties:
5959

60-
- The UI allows the user to edit environment properties and see the live changes in the application.
60+
- The UI allows you to edit environment properties and see the live changes in the application.
6161
These edits are temporary and go away if the underlying pod is restarted.
62-
- For each of the configured environment properties, the user can edit its value by clicking on the
62+
- For each of the configured environment properties, you can edit its value by clicking on the
6363
**Override** button in the same row.
64-
After the value is saved, the user can view the message that the property was overridden from the
64+
After the value is saved, you can view the message that the property was overridden from the
6565
initial value. Also, the updated property is visible in the **Applied Overrides** section at the
6666
top of the page.
6767
The **Reset** button in the same row resets the environment property to the initial state.
68-
- The user can also edit or remove the overridden environment variables in the **Applied Overrides**
68+
- You can also edit or remove the overridden environment variables in the **Applied Overrides**
6969
section.
70-
- The **Applied Overrides** section also enables the user to add new environment properties to the
70+
- The **Applied Overrides** section also enables you to add new environment properties to the
7171
application.
7272

7373
> **Note** The `management.endpoint.env.post.enabled=true` must be set in the application config
@@ -94,7 +94,7 @@ Use the **Changes Only** toggle to display the changed log levels.
9494
Use the search feature to search by logger name.
9595
Click **Reset All** to reset all the loggers to the default state.
9696

97-
> **Note** The UI allows the user to change the log levels and see the live changes on the application.
97+
> **Note** The UI allows you to change the log levels and see the live changes on the application.
9898
> These changes are temporary and go away if the underlying pod is restarted.
9999
100100
![Screenshot of the Log Levels page. The log level WARN is selected for every logger except Default.](images/log-levels-steeltoe.png)
@@ -135,12 +135,12 @@ To access the **Request Mappings** page, select the **Request Mappings** option
135135

136136
This page provides information about the application’s request mappings.
137137
For each mapping, the page displays the request handler method.
138-
The user can view more details of the request mapping, such as the header metadata of the application.
138+
You can view more details of the request mapping, such as the header metadata of the application.
139139

140-
When a user clicks on the request mapping, a side panel appears.
140+
When you click on the request mapping, a side panel appears.
141141
This panel contains information about the mapping-media types `Produces` and `Consumes`.
142142
The panel also displays the `Handler` class for the request.
143-
The search feature enables the user to search for the request mapping or the method.
143+
The search feature enables you to search for the request mapping or the method.
144144
The toggle **/actuator/\*\* Request Mappings** displays the actuator-related mappings of the
145145
application.
146146

@@ -155,13 +155,13 @@ The **HTTP Requests** page provides information about HTTP request-response exch
155155
application.
156156

157157
The graph visualizes the requests per second, which indicates the response status of all the requests.
158-
The user can filter by the response statuses, which include **info**, **success**, **redirects**,
158+
You can filter by the response statuses, which include **info**, **success**, **redirects**,
159159
**client-errors**, and **server-errors**.
160160
The trace data is captured in detail in a tabular format with metrics, such as **timestamp**,
161161
**method**, **path**, **status**, **content-type**, **length**, and **time**.
162162

163163
The search feature on the table filters the traces based on the search text box value.
164-
By clicking on the timestamp, the user can view more details of the request, such as method, headers,
164+
By clicking on the timestamp, you can view more details of the request, such as method, headers,
165165
and the response of the application.
166166

167167
The refresh icon above the graph loads the latest traces of the application.
@@ -203,7 +203,7 @@ You can choose from a list of actuator endpoints and parse through the raw actua
203203

204204
## <a id="troubleshooting"></a> Troubleshooting
205205

206-
You might run into cases where a workload running on your cluster does not show up in the
206+
You might run into cases where a workload running on your cluster does not appear in the
207207
Application Live View overview, or the Details pages do not load any information while running, or
208208
other similar issues.
209209
For help with troubleshooting common issues, see [Troubleshooting](../../app-live-view/troubleshooting.hbs.md).

tap-gui/plugins/application-accelerator.hbs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ To develop your code:
8080
## <a id='next-steps'></a>Next steps
8181

8282
To learn more about Application Accelerator for VMware Tanzu, see the
83-
[Application Accelerator documentation](../../application-accelerator/about-application-accelerator.md).
83+
[Application Accelerator documentation](../../application-accelerator/about-application-accelerator.hbs.md).

tap-gui/plugins/runtime-resource-visibility.hbs.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ associated with their workloads.
99

1010
Do one of the following actions to access the Runtime Resources Visibility plug-in:
1111

12-
- [Install the Tanzu Application Platform Full or View profile](../../install-intro.md)
13-
- [Install Tanzu Application Platform without using a profile](../../install-intro.md) and then
14-
install [Tanzu Developer Portal separately](../install-tap-gui.md)
12+
- [Install the Tanzu Application Platform Full or View profile](../../install-intro.hbs.md)
13+
- [Install Tanzu Application Platform without using a profile](../../install-intro.hbs.md) and then
14+
install [Tanzu Developer Portal separately](../install-tap-gui.hbs.md)
1515
- Review the section [If you have a metrics server](#metrics-server)
1616

1717
## <a id="metrics-server"></a> If you have a metrics server
@@ -45,28 +45,28 @@ Where:
4545

4646
You can retrieve this secret's ID by running:
4747

48-
```kubectl
48+
```console
4949
kubectl get secrets -n tap-gui
5050
```
5151

5252
and then running
5353

54-
```kubectl
54+
```console
5555
kubectl describe secret tap-gui-token-ID
5656
```
5757

58-
Where ID is the secret name from the first step.
58+
Where `ID` is the secret name from the first step.
5959

6060
> **Caution** If you enable metrics for a cluster but do not have a metrics server running on it,
6161
> Tanzu Application Platform web interface users see an error notifying them that there is a
6262
> problem connecting to the back end.
6363

6464
## <a id="Visualize-app"></a> Visualize Workloads on Tanzu Developer Portal
6565

66-
In order to view your applications on Tanzu Developer Portal, use the following steps:
66+
To view your applications on Tanzu Developer Portal, use the following steps:
6767

68-
1. [Deploy your first application on the Tanzu Application Platform](../../getting-started/deploy-first-app.md)
69-
1. [Add your application to Tanzu Developer Portal Software Catalog](../../getting-started/deploy-first-app.md#add-app-to-gui-cat)
68+
1. [Deploy your first application on the Tanzu Application Platform](../../getting-started/deploy-first-app.hbs.md)
69+
1. [Add your application to Tanzu Developer Portal Software Catalog](../../getting-started/deploy-first-app.hbs.md#add-app-to-gui-cat)
7070

7171
## <a id="nav-rr-vis-screen"></a> Navigate to the **Runtime Resources Visibility** screen
7272

@@ -101,7 +101,7 @@ Supply Chain, including:
101101
- Knative Services, Configurations, Revisions, and Routes
102102

103103
For more information, see
104-
[Supply Chain Choreographer in Tanzu Developer Portal](scc-tap-gui.md).
104+
[Supply Chain Choreographer in Tanzu Developer Portal](scc-tap-gui.hbs.md).
105105

106106
CRDs from Supply Chain are associated with Knative Resources, further down the chain, and built-in
107107
resources even further down the chain.
@@ -132,8 +132,8 @@ The following are some attributes that are displayed in the overview card:
132132

133133
![Screenshot of an Overview card. The VIEW POD LOGS and VIEW dot YAML buttons are at the top-right.](images/runtime-resources-overview.png)
134134

135-
>**Note** The **VIEW CPU AND MEMORY DETAILS** and **VIEW THREADS** sections are only available for
136-
applications supporting Application Live View.
135+
> **Note** The **VIEW CPU AND MEMORY DETAILS** and **VIEW THREADS** sections are only available for
136+
> applications supporting Application Live View.
137137

138138
### <a id="status-card"></a>Status card
139139

@@ -187,7 +187,7 @@ user-configured resource limits on the pod, defined in accordance with the
187187

188188
For applications built using Spring Boot, you can also monitor the actual
189189
real-time resource use using
190-
[Screenshot of Application Live View for Spring Boot Applications in Tanzu Developer Portal.](app-live-view-springboot.md).
190+
[Screenshot of Application Live View for Spring Boot Applications in Tanzu Developer Portal.](app-live-view-springboot.hbs.md).
191191

192192
Metrics and limits are also displayed for each container on a pod details page.
193193
If a particular container's current limit conflicts with a namespace-level
@@ -215,7 +215,7 @@ Kubernetes manages these resource units by using a binary base, which is explain
215215
## <a id="pod-details"></a>Navigating to Application Live View
216216

217217
To view additional information about your running applications, see the
218-
[Application Live View](app-live-view-springboot.md) section in the **Pod Details** page.
218+
[Application Live View](app-live-view-springboot.hbs.md) section in the **Pod Details** page.
219219

220220
![Screenshot of Tanzu Java web app runtime resource detail page.](images/runtime-resources-pod-details.png)
221221

@@ -251,7 +251,7 @@ For optimal performance, the pod logs page limits the total log entries displaye
251251

252252
### <a id="changing-log-levels"></a>Changing log levels
253253

254-
If the pod is associated with an application that supports [Application Live View](app-live-view.md),
254+
If the pod is associated with an application that supports [Application Live View](app-live-view.hbs.md),
255255
you can change the application's log levels by clicking the **Change Log Levels** button.
256256
You then see a panel that enables you to select levels for each logger associated with your application.
257257

tap-gui/plugins/sa-tap-gui.hbs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The sum of a workload's CVEs might not match the
5050
The data on this dashboard is based on `kubectl describe` for `SourceScan` and `ImageScan`.
5151
The data on the Supply Chain Choreographer's Vulnerability Scan Results is based on Metadata Store data.
5252

53-
Only vulnerability scans associated to a Cartographer workload appear.
53+
Only vulnerability scans associated with a Cartographer workload appear.
5454
Use [tanzu insight](../../cli-plugins/insight/cli-overview.hbs.md) to view results for
5555
non-workload scan results.
5656

tap-gui/plugins/scc-tap-gui.hbs.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ Tanzu Developer Portal has automation for enabling connection between Tanzu Deve
3535
no configuration.
3636

3737
> **Important** There is a known issue with the automatic configuration breaking the SBOM download
38-
> feature introduced in Tanzu Application Platform v1.6. Please update `tap-values.yaml` as described
39-
> in [Troubleshooting](../../tap-gui/troubleshooting.hbs.md#sbom-not-working).
38+
> feature introduced in Tanzu Application Platform v1.6. To fix this issue, edit `tap-values.yaml` as
39+
> described in [Troubleshooting](../../tap-gui/troubleshooting.hbs.md#sbom-not-working).
4040
4141
To deactivate this automation, add the following block to the Tanzu Developer Portal section within
4242
`tap-values.yaml`:
@@ -104,7 +104,7 @@ tap_gui:
104104
target: SOMETHING
105105
```
106106

107-
### <a id="scan-manual"></a> Manually connect Tanzu Developer Portal to Metadata Store
107+
### <a id="scan-manual"></a> Manually connect Tanzu Developer Portal to the Metadata Store
108108

109109
To manually enable CVE scan results:
110110

@@ -140,7 +140,8 @@ For more information, see [GitOps vs. RegistryOps](../../scc/gitops-vs-regops.hb
140140

141141
## <a id="sc-visibility"></a> Supply Chain Visibility
142142

143-
Before using the SCC plug-in to visualize a workload, you must create a workload.
143+
Before using the Supply Chain Visibility (SCC) plug-in to visualize a workload, you must create a
144+
workload.
144145

145146
The workload must have the `app.kubernetes.io/part-of` label specified, whether you manually create
146147
the workload or use one supplied with the OOTB supply chains.
@@ -661,7 +662,7 @@ To define a new `ClusterTemplate`:
661662
For example:
662663

663664
```console
664-
kubectl get ClusterTemplates config-writer-template -n my-apps -oyaml >> ~/cluster-template.yaml
665+
$ kubectl get ClusterTemplates config-writer-template -n my-apps -oyaml >> ~/cluster-template.yaml
665666
```
666667

667668
3. Verify that the file, when cleaned up, looks similar to the following:

0 commit comments

Comments
 (0)