Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make minor grammar/style changes to inspec.io #1441

Merged
merged 1 commit into from
Jan 30, 2017
Merged

Make minor grammar/style changes to inspec.io #1441

merged 1 commit into from
Jan 30, 2017

Conversation

jerryaldrichiii
Copy link
Contributor

This performs the following style changes to inspec.io:

Code example changes

  • Changes myap.conf to myapp.conf
  • Corrects spacing between control and 'sshd-21'
  • Corrects spacing between its and ( ) in multiple places
  • Fixes indentation in control 'sshd-21' example
  • Fixes #this is critical comment to match Ruby style guide
  • Adds spaces around {} to match Ruby style guide
  • Normalizes data types for cmp (Example: '8080' becomes 8080)
  • Removes leading space before describe file('/etc/myapp.conf')

Text changes

Match your infrastructure to your expectations.

becomes

Verify your infrastructure matches your expectations.


Rewords the following repeated block under Apply to all systems:

Combine profiles and customize them with overlays.
Pick controls and define exceptions as code

becomes

Analyze everything using the same codified profiles and controls.

Sentence Normalization

Normalizes the following messages to use the same "verb first" sentence structure:

Supports many fields like descriptions, tags, and impact.

becomes

Utilize many fields like descriptions, tags, and impact.


These tests are easy to understand by anyone, reducing friction.

becomes

Reduce friction by writing tests that are easy to understand by anyone.


Runs locally and remotely. Supports all major operating systems and configurations.

becomes

Run tests locally or remotely on all major operating systems and configurations.


Easily create custom resources and share them.

becomes

Create custom resources with ease and share them.

@chris-rock
Copy link
Contributor

@jerryaldrichiii Very nice. Thank you. Can you sign-off the commit? git commit --amend -s is doing the trick. See https://github.com/chef/inspec/blob/master/CONTRIBUTING.md

Signed-off-by: Jerry Aldrich III <jerry@chef.io>
@jerryaldrichiii
Copy link
Contributor Author

@chris-rock Hah! Completely forgot 🤦‍♂️

All better now.

@chris-rock chris-rock self-assigned this Jan 30, 2017
@chris-rock
Copy link
Contributor

Thank you @jerryaldrichiii

@chris-rock chris-rock merged commit ccf2b24 into inspec:master Jan 30, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants