mirror of
https://github.com/inspec/inspec
synced 2024-11-23 13:13:22 +00:00
811318f2f8
* Functional tests for userdir option * Accepts --config-dir CLI option * Actually loads a config file from the config dir, more cases to test * Able to load config and verify contents from config-dir * Functional tests to ensure precedence for config options * Enable setting config dir via env var * .inspec, not .inspec.d * Begin converting PluginCtl to PluginLoader/Registry * Able to load and partially validate the plugins.json file * More work on the plugin loader * Break the world, move next gen stuff to plugin/ * Be sure to require base cli in bundled plugins * Move test file * Revert changes to v1 plugin, so we can have a separate one * Checkpoint commit * Move v2 plugin work to v2 area * Move plugins v1 code into an isolated directory * rubocop fixes * Rip out the stuff about a user-dir config file, just use a plugin file * Two psuedocode test file * Working base API, moock plugin type, and loader. * Adjust load path to be more welcoming * Silence circular depencency warning, which was breaking a unit test * Linting * Fix plugin type registry, add tests to cover * Feedback from Jerry Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> |
||
|---|---|---|
| .. | ||
| dev | ||
| resources | ||
| shared | ||
| .gitignore | ||
| dsl_inspec.md | ||
| dsl_resource.md | ||
| glossary.md | ||
| habitat.md | ||
| inspec_and_friends.md | ||
| matchers.md | ||
| migration.md | ||
| platforms.md | ||
| plugin_kitchen_inspec.md | ||
| profiles.md | ||
| README.md | ||
| reporters.md | ||
| ruby_usage.md | ||
| shell.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:
- Auto-generating docs from code
- Transforming markdown+snippets in this folder into pure markdown in
www/source/docs - 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 versionsStability: Stable- API is well established and proofed. Maintaining compatibility is a high priorityStability: Locked- Only security and performance fixes are allowed