inspec/docs
Rony Xavier 041f64a87f New 'be_in' matcher for matching against values in a list (#2022)
* New matcher 'be_in'
Fixes #2018

Signed-off-by: Rony Xavier <rx294@nyu.edu>

* small fixes to wording.

Signed-off-by: Aaron Lippold <lippold@gmail.com>

* Added code to use be_in for with the following use case:
describe nginx do
   its(module_list) { should be_in AUTHORIZED_MODULE_LIST }
end
Fixes #2018

Signed-off-by: Rony Xavier <rx294@nyu.edu>

* Updates to the matcher
Fixes #2018

Signed-off-by: Rony Xavier <rx294@nyu.edu>

* Added tests for the be_in matcher

Signed-off-by: Rony Xavier <rx294@nyu.edu>

* Requested updates completed

Signed-off-by: Rony Xavier <rx294@nyu.edu>
2017-08-07 16:05:22 +02:00
..
resources Fix host resolution on Darwin, use dig wherever possible (#1986) 2017-07-05 10:45:30 -04:00
shared fix ident in cmp matcher docs 2017-03-02 12:28:50 +01:00
.gitignore ignore auto-generated docs 2016-09-22 16:47:54 +02:00
dsl_inspec.md describe the value ranges of impact 2017-04-25 19:01:16 +02:00
dsl_resource.md fix #1226 2016-11-03 00:32:31 +01:00
habitat.md Add docs for habitat CLI commands 2017-03-28 13:59:38 -04:00
inspec_and_friends.md add podcast link to docs on serverspec-inspec 2017-04-25 15:49:56 +02:00
matchers.md New 'be_in' matcher for matching against values in a list (#2022) 2017-08-07 16:05:22 +02:00
migration.md Minor grammar fix. 2017-05-07 08:50:58 -04:00
plugin_kitchen_inspec.md doc: Fix problem with link to plugin_kitchen_inspec 2017-02-26 17:25:39 +03:00
profiles.md attributes-related note added to docs (#1941) 2017-06-23 07:45:11 -07:00
README.md generate docs for cli 2016-09-22 13:43:57 +02:00
ruby_usage.md showing how to shellout in docs (#1689) 2017-04-21 13:47:28 -04:00
shell.md update docs to markdown 2016-09-22 10:16:16 +02:00

InSpec documentation

This is the home of the InSpec documentation. This documentation provides an introduction to this mechanism and shows how to write custom tests.

The goal of this folder is for any community member to clone these docs, make the changes, check if they are valid, and contribute to the project.

How to build docs

We build docs by:

  1. Auto-generating docs from code
  2. Transforming markdown+snippets in this folder into pure markdown in www/source/docs
  3. Rendering them to the website via instructions in www/

For development, you only need step 1!

1 Generate docs

To generate all docs run:

bundle exec rake docs

You can run tasks individually. For a list of tasks run:

bundle exec rake --tasks docs

Stability Index

Every available InSpec resource will indicate its stability. As InSpec matures, certain parts are more reliable than others. Brand new features are likely to be redesigned and marked as such.

The stability indices are as follows:

  • Stability: Deprecated - This features will be removed in future versions, because its known for being problematic. Do not rely on it.
  • Stability: Experimental - New features may change or are removed in future versions
  • Stability: Stable - API is well established and proofed. Maintaining compatibility is a high priority
  • Stability: Locked - Only security and performance fixes are allowed