Skip to content

Commit d1ac8ab

Browse files
committed
Tile Dev inclusive lang, etc
Double check
1 parent 72c1b82 commit d1ac8ab

28 files changed

+95
-98
lines changed

concourse.html.md.erb

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: How to perform continuous integration testing on your service title
2+
title: Continuous integration testing on your service tile
33
owner: Services
44
---
55

@@ -139,7 +139,7 @@ To configure install properties for your tile using the **Properties** tab:
139139
3. When you remove all of the red text box, click **Save** or **Save and Run**.
140140

141141

142-
### <a id="config-with-advanced-tab"></a> Configure your tile using the advanced - JSON properties Tab
142+
### <a id="config-with-advanced-tab"></a> Configure your tile using the advanced - JSON properties tab
143143

144144
In the **Advanced - JSON Properties** tab, you configure install properties, specifying them in JSON,
145145
in the format used by the om tool.
@@ -265,7 +265,7 @@ You define this pipeline in the `pipeline.yml` file that is uploaded to the
265265
Concourse server. The [Tile Generator](tile-generator.html) contains a sample
266266
pipeline that you can clone for your own tile.
267267

268-
### <a id="pool"></a> Set up <%= vars.platform_name %> for your CI Pipeline
268+
### <a id="pool"></a> Set up <%= vars.platform_name %> for your CI pipeline
269269

270270
<%= vars.company_name %> partners who have VMware host their pipeline have access to a pool of <%= vars.platform_name %>
271271
instances that are managed and are regularly updated with the latest

credhub.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: How to use CredHub with your service tile
33
owner: Services
44
---
5-
You can configure service tiles to store internal credentials in BOSH CredHub, instead of
5+
You can configure service tiles to store internal credentials in BOSH CredHub instead of
66
encoding them in product template and job template files.
77

88
BOSH CredHub is a secure credential management component that runs on the BOSH VM to minimize the surface area where

environments.html.md.erb

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: Development environments for your tile service
33
owner: Services
44
---
55

6-
Learn how to set up a tile development environment, from simple standalone tools to a full Ops Manager
6+
Learn how to set up a tile development environment from simple standalone tools to a full Ops Manager
77
development environment.
88
As you progress through the [stages](stages.html) of
99
tile development, you might progress through this environment.
1010

1111
## <a id='pcf'></a> <%= vars.app_runtime_abbr %> with Ops Manager
1212

13-
### <a id='shared'></a> Shared <%= vars.app_runtime_abbr %> Development Environments for VMware Tanzu Partners
13+
### <a id='shared'></a> Shared <%= vars.app_runtime_abbr %> Development environments for VMware Tanzu Partners
1414

1515
<%= vars.company_name %> operates and manages a number of shared <%= vars.app_runtime_abbr %> development environments,
1616
called Pivotal Integration Environments (PIEs),
@@ -29,7 +29,7 @@ using the credentials that you use for [Partners Slack](https://pivotalpartners.
2929

3030
If you are not in the PTPP or cannot access the Partners Slack, email [email protected].
3131

32-
### <a id='diy'></a> Install Your Own <%= vars.app_runtime_abbr %> Environment
32+
### <a id='diy'></a> Install your own <%= vars.app_runtime_abbr %> environment
3333

3434
If you need an isolated or dedicated <%= vars.app_runtime_abbr %> development environment, or you must work offline, you can install your own environment that includes Ops Manager:
3535

get-credhub-vars.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Fetching variable names and values with CredHub for your services
2+
title: Fetching variable names and values with CredHub
33
owner: CredHub
44
---
55

integrations-index.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ Here is information about service integrations with <%= vars.app_runtime_full %>
1919
* [Creating new variables in CredHub](/docs-tiledev/create-credhub-vars.html)
2020
* [Migrating existing credentials to CredHub](/docs-tiledev/migrating-credhub-credentials.html)
2121
* [Fetching variable names and values](/docs-tiledev/get-credhub-vars.html)
22-
* [Securing service credentials with Rrntime CredHub](/docs-tiledev/ssi-creds-tiledev.html)
22+
* [Securing service credentials with Runtime CredHub](/docs-tiledev/ssi-creds-tiledev.html)
2323
* [How to integrate services with Cloud Foundry's logging system](/docs-tiledev/nozzle.html)
2424
* [Syslog: migrating existing configuration](/docs-tiledev/migrating-syslog-configuration.html)

migrating-credhub-credentials.html.md.erb

+3-6
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,7 @@ corresponding CredHub credential types:
4040
</tr>
4141
</table>
4242

43-
<p class="note">
44-
<span class="note__title">Note</span>
45-
CredHub does not retain the salt when migrating <code>salted_credentials.
46-
</p>
43+
<p> CredHub does not retain the salt when you migrate <code>salted_credentials</code>.</p>
4744

4845
See [Property and template references](./property-template-references.html#secret) for more information about credential types.
4946

@@ -102,7 +99,7 @@ following the naming conventions in the [Update Values or Property Names using J
10299
<p class="note">
103100
<span class="note__title">Note</span>
104101
While the property blueprint refers to the type as <code>secret</code>, BOSH refers to the
105-
type as <code>password</code>. See the <a href="#cred-types">CredHub Credential Types</a> table at the beginning of this topic for more information about credential types.
102+
type as <code>password</code>. See the <a href="#cred-types">CredHub credential types</a> table at the beginning of this topic for more information about credential types.
106103
</p>
107104

108105
1. In your manifest snippet, replace the existing secret value with the new triple-parenthesis syntax.
@@ -122,4 +119,4 @@ type as <code>password</code>. See the <a href="#cred-types">CredHub Credential
122119

123120
3. Use an API endpoint to confirm that the credential is stored in the variable.
124121

125-
For more information about the endpoint, see [Fetching Variable Names and Values](./get-credhub-vars.html).
122+
For more information about the endpoint, see [Fetching variable names and values](./get-credhub-vars.html).

migrating-syslog-configuration.html.md.erb

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ title: Migrating existing syslog configuration to Ops Manager
33
owner: Ops Manager
44
---
55

6-
You can migrate existing syslog properties that are defined by a tile into a syslog form that is provided in Ops Manager v2.9 and later.
6+
You can migrate existing syslog properties that are defined by a tile into a syslog form that
7+
is provided in Ops Manager v2.9 and later.
78

89
When you enable the Ops Manager syslog feature, Ops Manager:
910

nozzle.html.md.erb

+2-3
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ owner: Services
55
You can integrate services with Cloud Foundry's logging system, _Loggregator_, by writing to and
66
reading from its _Firehose_ endpoint.
77

8-
9-
Cloud Foundry's Loggregator logging system collects your logs and metrics from apps and platform components
8+
The Loggregator logging system collects your logs and metrics from apps and platform components
109
and streams them to a single endpoint, Firehose.
1110

1211
Your tile can integrate its service with Loggregator in following ways:
@@ -337,7 +336,7 @@ element to carry VM instance information as follows:
337336

338337
## <a id="metrics"></a> Metrics
339338

340-
The [Monitoring <%= vars.platform_name %>](https://docs.pivotal.io/pivotalcf/monitoring/index.html) topic has a
339+
The [Logging and metrics in Cloud Foundry](https://docs.vmware.com/en/VMware-Tanzu-Application-Service/4.0/tas-for-vms/data-sources.html) topic has a
341340
rundown of the
342341
various metrics and how to make them useful.
343342

odb-resource-defaults.html.md.erb

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ owner: Ops Manager
66
You can configure the drop-down menu items for VM types and persistent disk types in your tile.
77

88
On-Demand service tiles have a configuration pane for each service plan.
9-
You can use the drop-down menus on the configuration pane to set the VM type and persistent disk type for
9+
You can use the drop-down menu on the configuration pane to set the VM type and persistent disk type for
1010
each instance of that plan.
1111

12-
Ops Manager populates the menus with options that are based on the VM and disk options available
12+
Ops Manager populates the menu with options that are based on the VM and disk options available
1313
on the current IaaS.
1414
When you set default values for VMs and disk types, it helps you to select the right
1515
resources for on-demand service

on-demand.html.md.erb

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: How to integrate your software as an on-demand service
2+
title: How to integrate your software as an On-Demand service
33
owner: Services
44
---
55

6-
You can integrate your software as an on-demand service and service tile for <%= vars.platform_name %>.
6+
You can integrate your software as an On-Demand service and service tile for <%= vars.platform_name %>.
77

88
Brokered service and managed service integrations assume that you have a single VM instance
99
deployed for your software, or a limited number of VMs.
@@ -15,29 +15,29 @@ On-Demand (dynamic) services activates this flexibility in a scalable way. When
1515
not pre-allocate VM resources for service instances. Instead, define an allowable range of VM memory and
1616
CPU sizes and create a dedicated network on the IaaS to host any required number of service instance VMs.
1717

18-
When a developer creates an instance of an on-demand service, they provision the resources within the
18+
When a developer creates an instance of an On-Demand service, they provision the resources within the
1919
allowed range, and BOSH dynamically creates a new, dedicated VM for the instance.
2020

21-
## <a id="create"></a> Create an on-demand service
21+
## <a id="create"></a> Create an On-Demand service
2222

2323
The best way to create an on-demand service is to use the
2424
[On-Demand Services SDK](https://docs.vmware.com/en/On-Demand-Services-SDK-for-VMware-Tanzu/0.43/on-demand-services-sdk/GUID-about.html).
2525

26-
The on-demand services SDK provides a generic on-demand service broker (ODB) that
26+
The On-Demand services SDK provides a generic On-Demand service broker (ODB) that
2727
the Tile Generator can consume like any other service broker.
2828

29-
The on-demand service author does not write a service broker. Instead, it writes a service adapter
29+
The On-Demand service author does not write a service broker. Instead, it writes a service adapter
3030
component that takes requests from the ODB and interfaces with the service software to fulfill requests
3131
from the ODB.
3232

3333
To create the tile, you need to feed the service adapter and the BOSH release of the ODB to
3434
[Tile Generator](./tile-generator.html):
3535

36-
* [On-demand services SDK](https://docs.vmware.com/en/On-Demand-Services-SDK-for-VMware-Tanzu/0.43/on-demand-services-sdk/GUID-index.html) documentation explains how to write a service
36+
* [On-Demand services SDK](https://docs.vmware.com/en/On-Demand-Services-SDK-for-VMware-Tanzu/0.43/on-demand-services-sdk/GUID-index.html) documentation explains how to write a service
3737
adapter for an on-demand service that uses the ODB.
3838

3939
* After you have the individual components for your brokered service integration, you can work
40-
through [Building Your First Tile](./index.html#tile-steps) to create your tile.
40+
through [Building your first tile](./index.html#tile-steps) to create your tile.
4141

4242
At any level of integration, you must use [Concourse](./concourse.html) for continuous integration
4343
during development.

property-template-references.html.md.erb

+7-6
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ Use these instructions to describe your product template for your tile and learn
77

88
The `metadata` subdirectory of a tile contains a product template file in `.yml` file format. The product template file specifies how the tile interface collects configurable properties from the user, and how Ops Manager incorporates these properties into the deployment manifest.
99

10-
1110
## <a id="product-template"></a> Product template contents
1211

1312
The product template, a `.yml` file in the tile's `metadata` subdirectory, includes or points to:
@@ -30,7 +29,7 @@ a functional tile that is provided by the Ops Manager engineering team that depl
3029

3130
For more information about product template configuration, see [Top-Level Properties](#top-level).
3231

33-
To learn how to configure your tile's forms, see [Form Properties](#form-properties).
32+
To learn how to configure your tile's forms, see [Form properties](#form-properties).
3433

3534

3635
## <a id='property-values'></a> Editing the product template
@@ -85,7 +84,7 @@ Some property values in a product template, such as CredHub credentials, must be
8584

8685
Ops Manager gets rid of the outer parentheses from these expressions and includes the resulting double-parens expressions in the manifest it generates, for BOSH to evaluate at deploy time.
8786

88-
For more information about tile properties, see [Referencing Properties](#property-refs).
87+
For more information about tile properties, see [Referencing properties](#property-refs).
8988

9089
### <a id='property-refs'></a> Referencing properties
9190

@@ -107,7 +106,8 @@ Where:
107106

108107
#### <a id="property-location"></a> Referencing a location
109108

110-
The method of referencing the location of the property varies. The following table describes the different methods of referencing a property:
109+
The method of referencing the location of the property varies.
110+
The following table describes the different methods of referencing a property:
111111

112112
| Method Name | Description |
113113
| ----------- | ----------- |
@@ -119,7 +119,8 @@ The method of referencing the location of the property varies. The following tab
119119

120120
#### <a id="accessor-location"></a> Referencing an accessor
121121

122-
Accessors vary between property blueprint types. The following example uses the property blueprint type `string` with its one accessor, `value`:
122+
Accessors vary between property blueprint types.
123+
The following example uses the property blueprint type `string` with its one accessor, `value`:
123124

124125
```console
125126
(( .properties.example-string.value ))
@@ -133,7 +134,7 @@ For example:
133134
(( .properties.example-string.value || [] ))
134135
```
135136

136-
For more information about the available properties and their accessors, see [Property Blueprint Reference](#property-blueprints).
137+
For more information about the available properties and their accessors, see [Property Blueprint reference](#property-blueprints).
137138

138139
### <a id='product'></a> Product context
139140

publish.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You can publish and update your service tile for <%= vars.platform_name %>.
77

88
## <a id="publish"></a> Publish your service tile
99

10-
The [Partner Software Product Release Cycle](./releases.html) explains how <%= vars.company_name %> works with partners to release VMware Tanzu products,
10+
The [Partner software product release cycle](./releases.html) explains how <%= vars.company_name %> works with partners to release VMware Tanzu products,
1111
from the private alpha and closed beta phases, to general availability and publication on [VMware Tanzu Network](http://network.pivotal.io).
1212

1313
After you package your product's BOSH releases, stemcell, metadata, and other tile components into a single zipped download file, post it to VMware Tanzu Network in one of two ways:

publishing-index.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ Learn about how to publish and update your service tile.
77

88
* [Publish and update](/docs-tiledev/publish.html)
99
* [Creating tile documentation](/docs-tiledev/tile-documentation.html)
10-
* [Partner software product release Cycle](/docs-tiledev/releases.html)
10+
* [Partner software product release cycle](/docs-tiledev/releases.html)
1111
* [Upgrading tiles](/docs-tiledev/tile-upgrades.html)

reference.html.md.erb

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ building your <%= vars.platform_name %> tiles.
1111
Use these resources to troubleshoot more complex issues:
1212

1313
- [Troubleshooting <%= vars.platform_name %>](https://docs.vmware.com/en/VMware-Tanzu-Application-Service/4.0/tas-for-vms/troubleshooting.html)
14-
- [Troubleshooting Applications](https://docs.vmware.com/en/VMware-Tanzu-Application-Service/4.0/tas-for-vms/deploy-apps-troubleshoot-app-health.html)
15-
- [Advanced Troubleshooting with BOSH CLI](https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/install-trouble-advanced.html)
14+
- [Troubleshooting applications](https://docs.vmware.com/en/VMware-Tanzu-Application-Service/4.0/tas-for-vms/deploy-apps-troubleshoot-app-health.html)
15+
- [Advanced troubleshooting with BOSH CLI](https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/install-trouble-advanced.html)
1616

1717
## <a id="api"></a>API
1818

@@ -25,9 +25,9 @@ create listings in the Services Marketplace.
2525

2626
## <a id="properties"></a>Configuration properties
2727

28-
* [Property and Template References](./property-template-references.html) catalogs how top-level properties, form properties, property blueprints, configurable properties, and job types are defined in tile installer `.yml` files, such as those generated by the Tile Installer or hand-coded legacy tiles. It also explains how to specify the locations of tile configuration properties in a tile installer `.yml` file.
28+
* [Property and template references](./property-template-references.html) catalogs how top-level properties, form properties, property blueprints, configurable properties, and job types are defined in tile installer `.yml` files, such as those generated by the Tile Installer or hand-coded legacy tiles. It also explains how to specify the locations of tile configuration properties in a tile installer `.yml` file.
2929

30-
* [Property Blueprint Reference](./property-template-references.html#property-blueprints) compiles a list of accessors and values for configuration properties in the `property_blueprints` section of a tile installer `.yml` file.
30+
* [Property Blueprint reference](./property-template-references.html#property-blueprints) compiles a list of accessors and values for configuration properties in the `property_blueprints` section of a tile installer `.yml` file.
3131

3232
## <a id="cli"></a>Command Line Tools
3333

0 commit comments

Comments
 (0)