Merge pull request #390 from jzohrab/readme_fixes

Readme fixes
This commit is contained in:
Christoph Hartmann 2016-01-25 11:21:55 -08:00
commit 1f325b1cfd
3 changed files with 8 additions and 6 deletions

View file

@ -60,7 +60,7 @@ The following example shows a full resource using attributes and methods to prov
'
# Load the configuration file on initialization
def initialiaze(path = nil)
def initialize(path = nil)
@path = path || '/etc/gordon.conf'
@params = SimpleConfig.new( read_content )
end
@ -87,4 +87,4 @@ The following example shows a full resource using attributes and methods to prov
For a full example, see our `example resource`_.
.. _example resource: ../examples/profile
.. _example resource: ../examples/profile/libraries/gordon_config.rb

View file

@ -91,9 +91,11 @@ This list can contain simple names, names and versions, or detailed flags for th
InSpec profile verification
-----------------------------------------------------
InSpec ships with a verification command that verifies the implementation of a profile
InSpec ships with a verification command that verifies the implementation of a profile:
$ inspec check examples/profile
.. code-block:: bash
$ inspec check examples/profile
InSpec profile archive
@ -144,7 +146,7 @@ The `include_controls` keyword allows you to import all rules from an existing p
**Inherit from a profile, but skip some rules**
Sometimes, not all requirements can be fullfiled for a legacy application. To manage the derivation, you can skip certain controls with `skip_control`.
Sometimes, not all requirements can be fulfilled for a legacy application. To manage the derivation, you can skip certain controls with `skip_control`.
.. code-block:: bash

View file

@ -1,6 +1,6 @@
# Example InSpec Profile
This example shows the implementation of a InSpec profile.
This example shows the implementation of an InSpec [profile](../../docs/profiles.rst).
## Verify a profile