mirror of https://github.com/inspec/inspec synced 2024-11-23 13:13:22 +00:00

History

Dominik Richter c8638f9917 update docs to markdown run 2/3		2016-09-22 10:16:16 +02:00
..
cli.rst	Generate documentation for the `vendor` command	2016-08-26 09:33:19 +01:00
dsl_inspec.md	update docs to markdown	2016-09-22 10:16:16 +02:00
dsl_resource.md	update docs to markdown	2016-09-22 10:16:16 +02:00
inspec_and_friends.md	update docs to markdown	2016-09-22 10:16:16 +02:00
matchers.md	update docs to markdown	2016-09-22 10:16:16 +02:00
plugin_kitchen_inspec.html.md	update docs to markdown	2016-09-22 10:16:16 +02:00
profiles.md	update docs to markdown	2016-09-22 10:16:16 +02:00
README.md	update docs to markdown	2016-09-22 10:16:16 +02:00
resources.rst	Fix minor typo in documentation	2016-09-15 15:27:44 -05:00
ruby_usage.rst	promote cmp usage as it provides results with octal mode	2016-08-30 18:23:47 +01:00
shell.md	update docs to markdown	2016-09-22 10:16:16 +02:00

README.md

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

TODO

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