inspec/docs
Kayleigh Doores 9c1b7eb6a2 Added db_name flag (#3383)
* Added db_name flag
* removed trailing whitespace
* Added comment to disable metrics

Signed-off-by: Kayleigh <kayleigh.doores@gmail.com>
2018-09-17 20:59:31 -04:00
..
dev Plugins V2 API: CLI Command Plugin Type, Again (#3296) 2018-08-16 20:22:28 -04:00
resources Added db_name flag (#3383) 2018-09-17 20:59:31 -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 Markdown and code fence fixes (#3230) 2018-07-19 14:31:38 -04:00
dsl_resource.md docs: Update example resource (#2904) 2018-04-05 08:50:49 -04:00
glossary.md Markdown and code fence fixes (#3230) 2018-07-19 14:31:38 -04:00
habitat.md Markdown and code fence fixes (#3230) 2018-07-19 14:31:38 -04:00
inspec_and_friends.md Markdown and code fence fixes (#3230) 2018-07-19 14:31:38 -04:00
matchers.md Markdown and code fence fixes (#3230) 2018-07-19 14:31:38 -04:00
migration.md Fix typo in some docs (#2841) 2018-03-20 08:43:30 -04:00
platforms.md edits to platforms doc (#2695) 2018-02-19 23:29:19 +01:00
plugin_kitchen_inspec.md Markdown and code fence fixes (#3230) 2018-07-19 14:31:38 -04:00
profiles.md Fix rendering of profiles webpage. (#3393) 2018-09-17 17:41:42 -04:00
README.md Bup the release to test new gem builds (#3071) 2018-05-17 20:05:04 -04:00
reporters.md Markdown and code fence fixes (#3230) 2018-07-19 14:31:38 -04:00
ruby_usage.md Markdown and code fence fixes (#3230) 2018-07-19 14:31:38 -04:00
shell.md Add additional links to Learn Chef Rally content (#2477) 2018-03-14 11:01:12 -04: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