DS-17868 Adjust wording after HIE review

Sudio Tan · DeepSecurityOpenSourceSupport · commit 73947eefa948 · 2018-01-05T14:38:58.000+08:00
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
 # Chef
 
-A cookbook of Chef recipes for the Trend Micro Deep Security Agent. This allows for the easy deployment of the Trend Micro Deep Security Agent as well as taking some common actions from the agent.
+A cookbook of Chef recipes for the Trend Micro Deep Security Agent. The recipes allow you to easily deploy the Deep Security Agent and perform a few common agent tasks.
 
 ## Support
 
-This is a community project and supported by Trend Micro Deep Security team.
+This is a community project that is supported by the Deep Security team.
 
 Tutorials, feature-specific help, and other information about Deep Security is available from the [Deep Security Help Center](https://help.deepsecurity.trendmicro.com/Welcome.html). 
 
@@ -16,28 +16,28 @@ This repository is also setup for use from [AWS OpsWorks](https://aws.amazon.com
 
 To enable a custom cookbook:
 
-1. From within your stack, click the "Stack Settings" button
-1. On the stack setting page, click the blue "Edit" button
-1. Slide the "Use custom Chef cookbooks" toggle to "Yes"
-1. Set the follow:
+1. From within your stack, click the "Stack Settings" button.
+1. On the stack setting page, click the blue "Edit" button.
+1. Slide the "Use custom Chef cookbooks" toggle to "Yes".
+1. Set the input fields as follow:
 	- "Repository type": *git*
 	- "Repository URL": *https://github.com/deep-security/chef.git*
-1. Click the blue "Save" button
-1. On the "Deployments" page for your stack, click the gray "Run Command" button
+1. Click the blue "Save" button.
+1. On the "Deployments" page for your stack, click the gray "Run Command" button.
 
-If you have existing instances running, do the following;
+If you have existing instances running, do the following:
 
-1. Select "Update Custom Cookbooks" from the "Command" drop-down
-1. Click the blue, "Update Custom Cookbooks" button to run the command
+1. Select "Update Custom Cookbooks" from the "Command" drop-down.
+1. Click the blue, "Update Custom Cookbooks" button to run the command.
 
 In the Layers section of the OpsWorks Management Console, for your layer;
 
-1. Click Recipes
-1. Under "Custom Recipes", in the "*Configuration*" life cycle enter **deep-security-agent::default**
-1. Click the General Settings section
-1. In the "Custom JSON" section, enter the necessary recipe settings
+1. Click Recipes.
+1. Under "Custom Recipes", in the "*Configuration*" life cycle enter **deep-security-agent::default**.
+1. Click the General Settings section.
+1. In the "Custom JSON" section, enter the necessary recipe settings.
 
-The recipe settings will be along the lines of;
+The recipe settings will be along the lines of:
 
 ```javascript
 {
@@ -60,19 +60,19 @@ The recipes within this repo are now available to you from within your AWS OpsWo
 
 Since AWS OpsWorks only allows one custom cookbook per stack. You have to do a little extra work if you want to incorporate multiple custom cookbooks. Thankfully, git makes this easy. 
 
-1. Create a new repo that you will use as your custom cookbook
-1. Add each cookbook you want to use as a [```git submodule```](http://git-scm.com/docs/git-submodule)
-1. Create a symbolic link to the recipe at the top level of the new repo (```ln -s clone/recipe recipe```)
+1. Create a new repo that you will use as your custom cookbook.
+1. Add each cookbook you want to use as a [```git submodule```](http://git-scm.com/docs/git-submodule).
+1. Create a symbolic link to the recipe at the top level of the new repo (```ln -s clone/recipe recipe```).
 
 This will keep each of the customer cookbook in it's own git repo but allow you to point OpsWorks to one place.
 
 ## Contributing
 
 We're always open to PRs from the community. To submit one:
 
-1. Fork the repo
-1. Create a new feature branch
-1. Make your changes
+1. Fork the repo.
+1. Create a new feature branch.
+1. Make your changes.
 1. Submit a PR with an explanation of what/why/caveats/etc.
 
-We'll review and work with you to make sure that the fix gets pushed out quickly. For further help, please contact maintainer email deepsecurityopensource@trendmicro.com.
+We'll review and work with you to make sure that the fix gets pushed out quickly. For further help, please contact the Trend Micro open source support team at deepsecurityopensource@trendmicro.com.
diff --git a/deep-security-agent/README.md b/deep-security-agent/README.md
@@ -2,7 +2,7 @@ A collection of recipes to help deploy and manage the Trend Micro Deep Security
 
 ## Requirements
 
-All of the recipes in this cookbook require a working Trend Micro Deep Security infrastructure. The key component is the Trend Micro Deep Security Manager. The agents (which these recipes help you manage) do the heavy lifting but the manager gives the marching orders. 
+All of the recipes in this cookbook require a working Deep Security infrastructure. The key component is the Trend Micro Deep Security Manager. The agents (which these recipes help you manage) do the heavy lifting but the manager gives the marching orders. 
 
 There are no specific technical requirements beyond a standard Chef deployment.
 
@@ -13,8 +13,8 @@ There are no specific technical requirements beyond a standard Chef deployment.
 
 Key | Type | Description | Default
 ----|------|-------------|--------
-['dsm_agent_download_hostname'] | String | Hostname of the Deep Security Manager | app.deepsecurity.trendmicro.com
-['dsm_agent_download_port'] | Int | The port to connect to the Deep Security Manager on to download the agents. This is typically the same port as the admin web access. | 443
+['dsm_agent_download_hostname'] | String | Hostname of the Deep Security Manager. | app.deepsecurity.trendmicro.com
+['dsm_agent_download_port'] | Int | The port to connect to the Deep Security Manager to download the agents. This is typically the same port as the one used to access the Deep Security Manager admin interface. | 443
 ['ignore_ssl_validation'] | Boolean |  Whether or not to ignore the SSL certificate validation for agent downloads. Marketplace and software deployments ship with self-signed certificates and require this set to 'true'. | false
 ['dsm_agent_activation_hostname'] | String | The hostname for the agents to communicate with once deployed. For Marketplace and software deployments this is typically the same hostname as 'dsm_agent_download_hostname'. | agents.deepsecurity.trendmicro.com
 ['dsm_agent_activation_port'] | Int | The port to use for the agent heartbeat (the regular communication). For Marketplace and software deployments, the default is 4120. | 443
@@ -27,7 +27,7 @@ Key | Type | Description | Default
 
 #### Recipe : deep-security-agent::default
 
-Make sure that you include 'deep-security-agent' in your node's 'run_list'. This will ensure that the Deep Security Agent is installed (it's the default.rb recipe).
+Make sure that you include 'deep-security-agent' in your node's 'run_list'. This ensures that the Deep Security Agent is installed (it's the default.rb recipe).
 
 ```json
 {
diff --git a/deep-security-agent/attributes/default.rb b/deep-security-agent/attributes/default.rb
@@ -12,7 +12,7 @@
 ########################
 
 # As you add agents to Deep Security, they are automatically made available for download through
-#   the same hostname:port as the admin interface. For Marketplace and software deployments, pass
+#   the same hostname:port as the Deep Security Manager admin interface. For Marketplace and software deployments, pass
 #   this data through the 'dsm_agent_download_hostname' & 'dsm_agent_download_port' attributes.
 default['deep_security_agent']['dsm_agent_download_hostname'] = 'app.deepsecurity.trendmicro.com'
 default['deep_security_agent']['dsm_agent_download_port'] = '443'
@@ -21,17 +21,17 @@
 #    unless you've installed a verifiable SSL certificate.
 default['deep_security_agent']['ignore_ssl_validation'] = false
 
-# Deep Security agents activate on a different port then the admin interface. For Marketplace and
+# Deep Security agents activate on a different port than the admin interface. For Marketplace and
 #    software deployments, 'dsm_agent_activation_hostname' is typically the same as 'dsm_agent_download_hostname'
-#    but 'dsm_agent_activation_port' will be different then 'dsm_agent_download_port'. For Deep Security
+#    but 'dsm_agent_activation_port' is different than 'dsm_agent_download_port'. For Deep Security
 #    as a Service, it's the reverse to make it easy to configure only one outbound port.
 default['deep_security_agent']['dsm_agent_activation_hostname'] = 'agents.deepsecurity.trendmicro.com'
 default['deep_security_agent']['dsm_agent_activation_port'] = '443'
 
 # For multi-tenant deployments of Deep Security (such as Deep Security as a Service), every tenant/organization
 #    is assigned a unique 'tenant_id' and 'tenant_password' that is only used for agent activation. You can
-#    find this info from the Support/Help > Deployment Scripts menu option in the admin. Select any agent
-#    and then check "Activate Agent automatically after installation". This will put the tenant_id and 
+#    find this info from the Support/Help > Deployment Scripts menu in the Deep Security Manager. Select any agent
+#    and then enable "Activate Agent automatically after installation". This places the tenant_id and 
 #    tenant_password in the script the wizard is building for you.
 default['deep_security_agent']['tenant_id'] = nil
 default['deep_security_agent']['token'] = nil
diff --git a/deep-security-agent/metadata.rb b/deep-security-agent/metadata.rb
@@ -2,6 +2,6 @@
 maintainer       'Trend Micro'
 maintainer_email 'deepsecurityopensource@trendmicro.com'
 license          'All rights reserved'
-description      'Installs/Configures the Deep Security agent'
+description      'Installs/Configures the Deep Security Agent'
 long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
 version          '1.0.0'
diff --git a/deep-security-agent/recipes/README.md b/deep-security-agent/recipes/README.md
@@ -2,19 +2,19 @@
 
 <dl>
 	<dt><a href="default.rb">default.rb</a></dt>
-	<dd>Deploys the Deep Security agent to the node<sup>1</sup></dd>
+	<dd>Deploys the Deep Security Agent to the node<sup>1</sup>.</dd>
 	<dt><a href="dsa-check-in-with-manager.rb">dsa-check-in-with-manager.rb</a></dt>
-	<dd>Asks the Deep Security agent to check in with the Deep Security manager (forced heartbeat)</a></dd>
+	<dd>Asks the Deep Security Agent to check in with the Deep Security Manager (forced heartbeat).</a></dd>
 	<dt><a href="dsa-create-diagnostic-package.rb">dsa-create-diagnostic-package.rb</a></dt>
-	<dd>Creates a diagnostic package for the agent and send it to the Deep Security manager</dd>
+	<dd>Creates a diagnostic package for the agent and send it to the Deep Security Manager.</dd>
 	<dt><a href="dsa-create-integrity-baseline.rb">dsa-create-integrity-baseline.rb</a></dt>
-	<dd>Create a baseline for the integrity monitoring engine</dd>
+	<dd>Create a baseline for the integrity monitoring engine.</dd>
 	<dt><a href="dsa-recommend-security-policy.rb">dsa-recommend-security-policy.rb</a></dt>
-	<dd>Scans the node and recommends a security policy based on the current profile of the node</dd>
+	<dd>Scans the node and recommends a security policy based on the current profile of the node.</dd>
 	<dt><a href="dsa-scan-for-integrity-changes.rb">dsa-scan-for-integrity-changes.rb</a></dt>
-	<dd>Scans the node for changes to the filesystem and memory based on the rules running in the integrity monitoring engine</dd>
+	<dd>Scans the node for changes to the filesystem and memory based on the rules running in the integrity monitoring engine.</dd>
 	<dt><a href="dsa-scan-for-malware.rb">dsa-scan-for-malware.rb</a></dt>
-	<dd>Scans the node for malware</dd>
+	<dd>Scans the node for malware.</dd>
 </dl>
 
 <sup>1</sup> Only the [default.rb](default.rb) recipe requires any data to be passed. These requirements are outlined in the [/deep-security-agent/README.md#attributes](../README.md#attributes) section of the main README. All other recipes run without any additional attributes.
diff --git a/deep-security-agent/test/cookbooks/deep-security-agent-test/README.md b/deep-security-agent/test/cookbooks/deep-security-agent-test/README.md
@@ -1,4 +1,4 @@
 ## deep-security-agent-test
 
-The cookbook is for DSA deployment verification. For Deep Security Agent deployment in production environment, please refer to <a href="https://github.com/deep-security/chef/tree/master/deep-security-agent">deep-security-agent cookbook</a>.
+This cookbook is for Deep Security Agent verification. For an agent deployment in a production environment, please refer to <a href="https://github.com/deep-security/chef/tree/master/deep-security-agent">deep-security-agent cookbook</a>.
 
diff --git a/deep-security-agent/test/cookbooks/deep-security-agent-test/metadata.rb b/deep-security-agent/test/cookbooks/deep-security-agent-test/metadata.rb
@@ -2,7 +2,7 @@
 maintainer       'Trend Micro'
 maintainer_email 'deepsecurityopensource@trendmicro.com'
 license          'All rights reserved'
-description      'Installs/Configures the Deep Security agent'
-long_description 'Cookbook for preparation to test deep-security-agent'
+description      'Installs/Configures the Deep Security Agent'
+long_description 'Cookbook to prepare for testing deep-security-agent'
 version          '1.0.0'
 
diff --git a/deep-security-agent/test/cookbooks/deep-security-agent-test/recipes/default.rb b/deep-security-agent/test/cookbooks/deep-security-agent-test/recipes/default.rb
@@ -5,8 +5,8 @@
 # Copyright 2017, Trend Micro
 
 
-# Disable required TTY session for sudo in RHEL and Centos
-# "requiretty" will block Kitchen's Inspect from verifying VM status
+# Disable required TTY session for sudo in RHEL and Centos.
+# "requiretty" blocks Kitchen's Inspect from verifying VM status.
 if node[:platform] =~ /redhat/ or node[:platform] =~ /centos/
   execute 'Set !require tty for kitchen user' do
     action :run

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`## deep-security-agent-test`
`2`	`2`
`3`		`-The cookbook is for DSA deployment verification. For Deep Security Agent deployment in production environment, please refer to <a href="https://github.com/deep-security/chef/tree/master/deep-security-agent">deep-security-agent cookbook</a>.`
	`3`	`+This cookbook is for Deep Security Agent verification. For an agent deployment in a production environment, please refer to <a href="https://github.com/deep-security/chef/tree/master/deep-security-agent">deep-security-agent cookbook</a>.`
`4`	`4`