Switch branches/tags
1-stable ER-508/inspec_faraday_resource HM-FixFontIssue-020817 aaronlippold-al/kernel_module_blacklist adamleff/auditd_rules-deprecation adamleff/bump-train-0.28.0 adamleff/exceptions-in-filtertable adamleff/fix-changelog-version adamleff/fix-json-formatter adamleff/fix-linked-containers adamleff/formatter-refactor adamleff/ignore-simulator-gems adamleff/oracledb_session_refactor adding-vm-extension cdn/pin-net-ssh chris-rock/resource-inheritance chris-rock/skip-exception chris-rock/tutorial-response-filename-length cw/check-uniq-controls cw/doc-analysis cw/doc-resource-authoring-guide cw/docs_dsl_spike cw/ec2_tags cw/extended-aws_ec2_instances cw/filtertable-they-theirs cw/handle-unable cw/init-plugin cw/plugin-cli-option cw/plugins-attribute-provider-type cw/plugins-cli-diagnostics cw/resource-collision cw/silence-rspec-deprecation-warning dom/proto dom/user-compliance dr/acls-registry dr/archive-tests dr/check-tests dr/cmd-nil-fix dr/describe-os dr/docs-md dr/full_id dr/nginx dr/os-methods dr/package.list dr/release-docker dr/www/fix-tutorial-loading dwm-tb/azure-storage-account dwm-tb/inspec-azure-cleanup gh-pages hackday2018/versioned-docs hamburglar-patch-1 hannah-radish-patch-1 ja/add-exec-git-https ja/add-hab-svc ja/add-path-to-git-fetcher ja/add-ssh-gem ja/deprecate-shadow-methods ja/fix-1825 ja/fix-docker-labels ja/fix-rack-vuln ja/pairing-branch ja/remove-hab-deps ja/update-entries-to-count jh/detect-freebsd-in-port jjh/apache_conf_subclass_file jq/add_windows_functional_tests jq/bump_release jq/bump_version jq/cli_help_commands jq/default_reporter_for_dynamic_runners jq/fix_audit_policy_supports jq/fix_inspec_ruby_2.5 jq/fix_legacy_reporter_output jq/fix_skip_include jq/fix_vendor_osx_test jq/formatter-refactor jq/help_mhackethal jq/inspec_2.0_reporter_changes jq/merge_inspec_azure jq/merge_json_cli_options jq/move_inspec_compliance_v2 jq/override_unf_ext jq/populate_code_for_merged_controls jq/supports_inspec_warn jq/test_builds jq/test_gcp_train jq/update_uuid_documentation jscott/addcomplianceapidoc kg/apache kg/auditd_conf kg/bond kg/clean-md kg/command kg/cran kg/docker_service kg/has-uses kg/instructions kg/key_rsa kg/limits_conf kg/login kg/matchers-blurb kg/normalize kg/resource-formatting kg/resource-packs kg/xml lcg/docfix2 master miah/filter-gems miah/override_unf_ext miah/uv miah/2720 miah/3034 miah/3315 mw/copy-edits mw/homepage nh/aws_iam_users_policies nh/aws_iam_users_pw_age nh/aws_organizations_member osenvparams require rk/cia-1176 rspec-core-dsl ruby250 shain/new_windows_toolchain shain/remove_www slim smaller sp/protect-file-nil sr/audit-mode sr/cli-tests sr/extras-compliance sr/fix-upload-profiles sr/inspec-mode sr/simplify-profile-ids sr/wip-cli-tests ssd/github-fetcher support-absolute-paths-in-apache_conf tb/heckraiser tb/2741-aws_route_table tduffield/build-without-bundler-groups tdufifeld/use-chefstyle test-keyvault-train train-plugin-doc-link-broken tvz/aws_eks_cluster ubergeekgirl-patch-1 update-control-block-website vj/try-paste
Nothing to show
Find file History

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

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