Skip to content

Commit 9bf879f

Browse files
Inclusive language
1 parent a40fba2 commit 9bf879f

17 files changed

+20
-26
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ git push origin my-new-feature
2727

2828
### Updating pull requests
2929

30-
If your PR fails to pass CI or needs changes based on code review, VMware recommends squashing these changes into existing commits.
30+
If your PR fails to pass CI or needs changes based on code review, squashing these changes into existing commits.
3131

3232
If your pull request contains a single commit or your changes are related to the most recent commit, you can amend the commit.
3333

bosh-release.html.md.erb

+2-3
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,7 @@ a managed service deployment using the [Tile Generator](tile-generator.html)'s
5757
support for `docker-bosh` packages. You can deploy pre-existing
5858
Docker images into BOSH-managed VMs on the <%= vars.platform_name %> infrastructure.
5959

60-
While this is a great, easy way to deploy your service on <%= vars.platform_name %>, we do not
61-
recommend this as a long-term, production-ready solution. There is really no
60+
While this is a great, easy way to deploy your service on <%= vars.platform_name %>, this is not a long-term, production-ready solution. There is really no
6261
benefit of running your service in containers on the VMs, and it does have
6362
a number of operational ("day 2") drawbacks:
6463

@@ -75,7 +74,7 @@ images you deploy.
7574
After the basic BOSH release is in place, additional features for logging
7675
help operators run the service. For logging information, see
7776
[syslog-release](https://github.com/cloudfoundry/syslog-release).
78-
<%= vars.company_name %> recommends you expose the property `syslog.migration.disabled` using the
77+
Expose the property `syslog.migration.disabled` using the
7978
tile's forms because not all customers configure syslog draining.
8079

8180
Logs written under the expected BOSH location `/var/vcap/sys/log` are forwarded

brokered.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ a good way to publish a first tile that adds real value for your customers who h
3232

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

35-
At any level of integration, <%= vars.company_name %> recommends and supports using [Concourse](./concourse.html) for continuous integration during development.
35+
At any level of integration, use [Concourse](./concourse.html) for continuous integration during development.

concourse.html.md.erb

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ There are two ways to do CI testing on your tile:
99

1010
+ Use the Tile Dashboard provided as a service by the <%= vars.company_name %> ISV team.<br>
1111
See [Use Tile Dashboard CI to Test Your Tile](#dashboard) below.<br>
12-
This is the method recommended by <%= vars.company_name %>.
1312
+ Set up and use your own Concourse pipeline.<br>
1413
See [Set Up a concourse pipeline and test your tile](#concourse) below.<br>
1514
New partners work on only one tile at a time.

dev-workflow.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Development workflow for your tile
33
owner: OpsMan
44
---
55

6-
This document references topics that follow <%= vars.company_name %>'s recommended tile development workflow in [Building Your First Tile](./index.html#tile-steps).
6+
This document references topics that follow <%= vars.company_name %>'s tile development workflow in [Building Your First Tile](./index.html#tile-steps).
77

88
## <a id="contents"></a> Development workflow
99

environments.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ of BOSH that can manage virtual machines and BOSH releases for you.
2020
purpose.
2121

2222
Between these two components, you will have everything you must develop
23-
tiles, except for Ops Manager. But if you followed the recommended workflow in [Building Your First Tile](index.html#tile-steps) you will not need an actual full
23+
tiles, except for Ops Manager. But if you followed the workflow in [Building Your First Tile](index.html#tile-steps) you will not need an actual full
2424
<%= vars.platform_name %> environment until the later phases of your development.
2525

2626
### <a id='setup-boshlite'></a> Setting up BOSH-Lite

managed.html.md.erb

+2-3
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ To integrate your service at this level, you will have to learn about stemcells,
2323

2424
### <a id="managed-mvp"></a> Minimal viable product
2525

26-
For a Minimal Viable Product (MVP) version of a managed service, we typically
27-
recommend that you aim for a single, shared service instance, and don't yet
26+
For a Minimal Viable Product (MVP) version of a managed service, you should aim for a single, shared service instance, and don't yet
2827
worry too much about High Availability of this instance. This integration level is mostly about getting the BOSH packaging, deployment, and monitoring working
2928
correctly.
3029

@@ -48,4 +47,4 @@ your persistent storage across those as well.
4847

4948
* The [Tile generator](./tile-generator.html) tool automatically creates the life cycle errands that can run after a <%= vars.platform_name %> tile is deployed or before it is removed. Operators control which errands run the next time they click **Apply Changes** to redeploy. See the [Errands](./tile-errands.html) topic for how <%= vars.platform_name %> operators control when errands run, and how to set default errand run rules in the tile.
5049

51-
At any level of integration, <%= vars.company_name %> recommends and supports using [Concourse](./concourse.html) for continuous integration during development.
50+
At any level of integration, use [Concourse](./concourse.html) for continuous integration during development.

nozzle.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ A service tile can install a nozzle as either a managed service, with package ty
8181

8282
### <a id="develop"></a> Develop a Nozzle
8383

84-
<%= vars.company_name %> recommends developing a nozzle in Go to use the
84+
You must develop a nozzle in Go to use the
8585
[NOAA library](https://github.com/cloudfoundry/noaa).
8686
NOAA does the heavy lifting of establishing
8787
an authenticated websocket connection to the logging system and de-serializing the protocol buffers.

on-demand.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To create their tile, the tile author then feeds their service adapter and the B
2929

3030
* Once you have the individual components for your brokered service integration, you can work through [Building Your First Tile](./index.html#tile-steps) to create your tile.
3131

32-
At any level of integration, <%= vars.company_name %> recommends and supports using [Concourse](./concourse.html) for continuous integration during development.
32+
At any level of integration, you must use [Concourse](./concourse.html) for continuous integration during development.
3333

3434
### <a id="dynamic-ha"></a> High availability
3535

pcf-command.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ credentials of a "claimed" <%= vars.platform_name %> pool resource to the CI pip
3636
For interactive use, this means that you will have to create a `metadata`
3737
file in the directory where you run the `pcf` command.
3838

39-
<p class='note'><%= vars.company_name %> recommends that you do <strong>not</strong> create this file inside your git or other version control system repository, as you do not want to accidentally commit these credentials to version control.</p>
39+
You should not create this file inside your git or other version control system repository, as you do not want to accidentally commit these credentials to version control.</p>
4040

4141
##<a id="commands"></a> Commands
4242

property-template-references.html.md.erb

+2-4
Original file line numberDiff line numberDiff line change
@@ -358,9 +358,7 @@ A description of the tile.
358358

359359
The order in which a tile appears on the dashboard. The BOSH Director always appears at rank 100.
360360

361-
For your tile to appear to the right of BOSH Director, you must set this value to an integer less than 100.
362-
363-
<%= vars.recommended_by %> recommends that you set it to 1.
361+
For your tile to appear to the right of BOSH Director, you must set this value to an integer less than 100. You should set it to 1.
364362

365363
If all tiles have the same rank, Ops Manager sorts them alphabetically.
366364

@@ -400,7 +398,7 @@ stemcell_criteria
400398
enable_patch_security_updates: false
401399
```
402400

403-
<%= vars.recommended_by %> recommends setting the `enable_patch_security_updates` property to `true`. If you set the property to `false`, your tile does not receive security patches through automatic stemcell updates.
401+
You should set the `enable_patch_security_updates` property to `true`. If you set the property to `false`, your tile does not receive security patches through automatic stemcell updates.
404402

405403
You do not specify which IaaS the stemcell targets. This keeps your product template IaaS agnostic so that one product template can be deployed on any IaaS.
406404

releases.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ To enter Closed Beta, a product must meet the following requirements:
4040

4141
* The product must fulfill its promised feature set, and perform as wanted.
4242

43-
<%= vars.company_name %> also recommends that any Closed Beta product include an easy way for users to provide feedback to the product developer.
43+
Aa Closed Beta product should include an easy way for users to provide feedback to the product developer.
4444

4545
### Steps to Release
4646
To create a new Closed Beta release for your product:

runtime-config.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ For more information about runtime config keys, see
7070

7171
For more information about top-level properties in the tile manifest, see [Top-Level Properties](./property-template-references.html#top-level).
7272

73-
<p class="note"><strong>Note:</strong> The names you choose must be unique across a deployment. <%= vars.company_name %> recommends appending your product name or another unique identifier to each of the named items in the <code>runtime_configs</code> section.</p>
73+
Append your product name or another unique identifier to each of the named items in the <code>runtime_configs</code> section.</p>
7474

7575

7676
## <a id="delete"></a>Delete a runtime config

stages.html.md.erb

+1-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ integration level increases. But none of the higher levels is required. You can
1111
stop service integration and declare it finished (enough) after any of these:
1212

1313
When integrating third-party software with Cloud Foundry, the effort
14-
typically progresses through increasing levels of integration. <%= vars.company_name %> recommends
15-
this staged approach because it allows early feedback on the value and the
14+
typically progresses through increasing levels of integration. This staged approach because it allows early feedback on the value and the
1615
design of the integration, which helps make better decisions about future
1716
stages.
1817

testing.html.md.erb

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Here's recommended testing practices for <%= vars.platform_name %> tile develope
1010
Good testing assures tile developers that their product installs and runs properly on diverse platforms
1111
and assures platform operators that the tile they install can provide its service on their platform.
1212

13-
<%= vars.company_name %> recommends a pyramid structure for testing, starting with unit tests and stepping up to successively broader and more automated levels of integration.
14-
<%= vars.company_name %> uses and recommends [Concourse](./concourse.html) for creating build pipelines that follow this test structure.
13+
Arrange fir a pyramid structure for testing, starting with unit tests and stepping up to successively broader and more automated levels of integration.
14+
Use [Concourse](./concourse.html) for creating build pipelines that follow this test structure.
1515
Other continuous integration tools must support a pyramid testing approach.
1616

1717
### <a id="pyramid"></a> Tile test pyramid

tile-reference/property-blueprints/_collection.html.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ This holds multiple records of a group of custom defined properties.
7272
<li>Any text box ending in <code>name</code></li>
7373
</ul>
7474
<br>
75-
<%= vars.recommended_by %> recommends including a logical key and setting
75+
You must include a logical key and setting
7676
<code>freeze_on_deploy: true</code> in each collection where you want to
7777
target “update” and “delete and add” operations separately.
7878
</td>

tools.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Tile development tools reference
33
owner: Services
44
---
5-
Here's tile development tools that <%= vars.company_name %> uses and recommends for tile development.
5+
Here's tile development tools for tile development.
66

77
* [Development environments](/docs-tiledev/environments.html) including simple standalone tools to a full <%= vars.platform_name %> development environment.
88

0 commit comments

Comments
 (0)