Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-30 08:30:39 +00:00
Code Issues Projects Releases Packages Wiki Activity
3142 commits 450 branches 1901 tags 75 MiB
Commit graph

190 commits

Author SHA1 Message Date
Christoph Hartmann
71127cf33e Merge pull request #1354 from jerryaldrichiii/fix-iis-site-example 
Remove trailing `\\` from iis_site example
 2016-12-12 11:06:32 +01:00
Jerry Aldrich III
f2e6577460 Remove trailing \\ from iis_site example 
Signed-off-by: Jerry Aldrich III <jerry@chef.io>
 2016-12-09 10:00:10 -05:00
Christoph Hartmann
a990d20fcd Merge pull request #1306 from username-is-already-taken2/digitalgaz/windows_task 
Adding windows_task resource
 2016-11-25 11:46:42 -07:00
Jerry Aldrich III
66a47ce8b9 Remove extra ' in registry key examples 
Signed-off-by: Jerry Aldrich III <jerry@chef.io>
 2016-11-21 10:18:01 -06:00
username-is-already-taken2
4084a770ef Added documentation 
Signed-off-by: username-is-already-taken2 <digitalgaz@hotmail.com>
 2016-11-20 20:25:03 +00:00
Franklin Webber
a9726910ff Fixes resources in the docs 
* Fixes the npm package example to state 'npm' vs 'gem'
* Fixes powershell resource to specify the resource instead of 'script'
* Updates the example to rename variable 'script'

While ruby would allow the local variable and the presence of the InSpec method at the same time I think that it is bad form. Other resource examples also use 'script'.

* Changes pip to show generic example

Other package like resources show a generic example in the default.

Signed-off-by: Franklin Webber <franklin@chef.io>
 2016-11-19 17:57:03 -08:00
Alex Pop
c94407ca2c docs: quoted version for package resource example 
Signed-off-by: Alex Pop <apop@chef.io>
 2016-11-16 11:24:19 +00:00
Christoph Hartmann
a95f0cf116 fix #1226 
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
 2016-11-03 00:32:31 +01:00
Artem Sidorenko
755f24ed6f Code-block directive is not needed here (#1247) 
and breaks the layout: http://inspec.io/docs/reference/resources/file/

Signed-off-by: Artem Sidorenko <artem@posteo.de>
 2016-10-25 23:26:08 +02:00
Seth
23456c5e86 Fix issue with registry_key example (#1243) 
* Fix issue with registry_key example

* Fix issue with registry_key example

Signed-off-by: Seth Thoenen <seththoenen@gmail.com>
 2016-10-25 22:34:30 +02:00
Nathen Harvey
7e4157ddf4 Headers and list elements that include more than one _ character were being rendered incorrectly. (Perhaps it is only when there are an even number but in any case I only found words with either one or two _s.) 
The html rendered from markdown would look like:

`<h3>be<em>grouped</em>into</h3>`

When there is only one `_` the html rendered correctly:

`<h3>be_directory</h3>`

This change escapes the `_` when there are multiple.

* New markdown:  `### be\_grouped\_into`
* New html:      `<h3>be_grouped_into</h3>`

resource matchers fixed:
* be_block_device
* be_character_device
* be_grouped_into
* be_linked_to
* be_owned_by
* have_app_pool
* have_property_value

resource fixed:
* parse_config_file

Signed-off-by: Nathen Harvey <nharvey@chef.io>
 2016-10-20 07:07:18 -04:00
Dominik Richter
b08de666e8 Merge pull request #1179 from davidwrede/doc_edits 
Changing headings to align with SEO best practices
 2016-09-30 15:33:21 +02:00
Victoria Jeffrey
3c9db53b6f add example for yumconf-like structured files 2016-09-30 13:37:47 +02:00
tpetchel
e2f878eaee Fix a few typos 2016-09-27 22:02:20 -04:00
David Wrede
9283f19b6e Changing headings to align with SEO best practices 
Signed-off-by: David Wrede <dwrede@chef.io>
 2016-09-27 12:03:23 -07:00
Alex Pop
9ce4ebb3a0 update dependency documentation and mention the lockfile 2016-09-26 16:31:06 +01:00
Steven Danna
3507c970a9
Document the require_resource function 
Signed-off-by: Steven Danna <steve@chef.io>
 2016-09-26 11:53:33 +01:00
Dominik Richter
babbf71dd1 add intro to inspec and friends 2016-09-26 06:21:05 +02:00
Dominik Richter
f9248033c3 render resource docs 2016-09-22 16:47:58 +02:00
Dominik Richter
dba8638e3a ignore auto-generated docs 2016-09-22 16:47:54 +02:00
Dominik Richter
67c990d19c add all partials for resources 2016-09-22 15:23:21 +02:00
Dominik Richter
5a5fa03321 add ruby usage in inspec as markdown 2016-09-22 15:06:04 +02:00
Dominik Richter
f179c88074 improve cli docs styling 2016-09-22 13:49:56 +02:00
Dominik Richter
a4982fc4f1 generate docs for cli 2016-09-22 13:43:57 +02:00
Christoph Hartmann
0e7c534ea7 1.0.0.beta2 2016-09-22 11:33:43 +02:00
Dominik Richter
c8638f9917 update docs to markdown 
run 2/3
 2016-09-22 10:16:16 +02:00
Jake Gage
6de1c47b72 Fix minor typo in documentation 2016-09-15 15:27:44 -05:00
Michał Sochoń
52b5b59b87 Extend Inspec DSL docs (#1006) 
Update dsl_inspec.rst
 2016-09-01 23:11:10 +02:00
Alex Pop
fd676ceb5c promote cmp usage as it provides results with octal mode 2016-08-30 18:23:47 +01:00
Steven Danna
f9952d922a Reformat service resource docs for discoverability 
This makes the service-manager-specific resources stand out a bit more
in the documentation.

Signed-off-by: Steven Danna <steve@chef.io>
 2016-08-26 11:23:59 +02:00
Steven Danna
91fa58f421
Generate documentation for the vendor command 
This was generated using `rake docs:cli`.
 2016-08-26 09:33:19 +01:00
Victoria Jeffrey
eb3b80ff87 document ini resource 2016-08-26 09:54:40 +02:00
Tim Smith
0dbe816f57 Docs should reference family not platform 
Signed-off-by: Tim Smith <tsmith@chef.io>
 2016-08-19 20:14:03 +02:00
Tim Smith
86247c012f Add missing platforms to the docs 
Signed-off-by: Tim Smith <tsmith@chef.io>
 2016-08-19 20:14:03 +02:00
Kartik Null Cating-Subramanian
83d9deda4f inspec shell documentation 2016-08-19 19:29:32 +02:00
Peter Burkholder
69a96665de Document awesome where syntax for port 2016-08-18 12:29:23 -04:00
Chris Evett
3df98b7a19 add iis_site tests and refactor post code review 2016-08-17 06:57:48 -04:00
Chris Evett
4d63afc1f8 add documentation to resources.rst for iis_site and fix comment 2016-08-17 06:57:48 -04:00
Dominik Richter
e637067c43 auto-genreate inspec cli docs 2016-08-12 13:40:59 +02:00
Patrick Münch
216a6aeac1 FIX: file(hba_config_file) test in documentation, it is not working and rubocop detect some issues 
Signed-off-by: Patrick Münch <patrick.muench1111@gmail.com>
 2016-07-14 13:06:41 +02:00
Patrick Münch
19c449b158 change the Test for risky database entries example 
Signed-off-by: Patrick Münch <patrick.muench1111@gmail.com>
 2016-07-06 16:07:32 +02:00
Montague, Brent
faffc236dd Add array documentation to yaml / json resource 2016-06-21 18:06:27 -04:00
Nick Rycar
820cd1ae86 Updating ctl docs to include the init command 2016-06-21 11:27:56 -07:00
Christoph Hartmann
e2b707f51d add documentation for bash resource 2016-06-19 23:46:20 +02:00
Tim Smith
b2876bf2f4 Update documentation for matching output of commands 2016-05-31 13:56:31 -07:00
Christoph Hartmann
7515b488fd Merge pull request #754 from jeremymv2/sudo_command 
add sudo_command option
 2016-05-16 15:32:29 +02:00
Christoph Hartmann
9896278599 remove string quotes from regex 2016-05-16 11:33:13 +02:00
Lamont Granquist
452047011d remove string quotes around regexp 2016-05-16 11:31:58 +02:00
Jeremy J. Miller
cfcc06a379 fix spelling 2016-05-15 11:04:23 -04:00
Jeremy J. Miller
9795879628 add sudo_command option 2016-05-15 07:22:18 -04:00