From 477ca568c94cabec5a0e6f8c82713160dee483c0 Mon Sep 17 00:00:00 2001 From: Jeff Zohrab Date: Mon, 25 Jan 2016 10:23:52 -0500 Subject: [PATCH 1/3] fix typos --- docs/dsl_resource.rst | 2 +- docs/profiles.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dsl_resource.rst b/docs/dsl_resource.rst index 3582995e0..cc2b234cc 100644 --- a/docs/dsl_resource.rst +++ b/docs/dsl_resource.rst @@ -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 diff --git a/docs/profiles.rst b/docs/profiles.rst index 6aa1594d7..11552632c 100644 --- a/docs/profiles.rst +++ b/docs/profiles.rst @@ -144,7 +144,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 From 10b760ff79cf85ed650d103b5c5e39b5be7c09eb Mon Sep 17 00:00:00 2001 From: Jeff Zohrab Date: Mon, 25 Jan 2016 10:25:08 -0500 Subject: [PATCH 2/3] add doc code formatting --- docs/profiles.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/profiles.rst b/docs/profiles.rst index 11552632c..d8855c6bd 100644 --- a/docs/profiles.rst +++ b/docs/profiles.rst @@ -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 From b6ba1ad46c368e211104f3fffe66c8fb88fa286d Mon Sep 17 00:00:00 2001 From: Jeff Zohrab Date: Mon, 25 Jan 2016 10:32:43 -0500 Subject: [PATCH 3/3] add doc links --- docs/dsl_resource.rst | 2 +- examples/profile/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dsl_resource.rst b/docs/dsl_resource.rst index cc2b234cc..2de67218a 100644 --- a/docs/dsl_resource.rst +++ b/docs/dsl_resource.rst @@ -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 diff --git a/examples/profile/README.md b/examples/profile/README.md index 21e43d89a..aec07dad4 100644 --- a/examples/profile/README.md +++ b/examples/profile/README.md @@ -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