Mary Jinglewski
c80a39e371
Indent Fix
...
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2020-01-14 16:16:54 -05:00
Mary Jinglewski
c45b4736ba
Update for InSpec Resource Code Examples
...
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2020-01-14 16:16:54 -05:00
CollinM
ca5a22829c
Update docs/resources/file.md.erb
...
Co-Authored-By: mjingle <mjingle@users.noreply.github.com>
Signed-off-by: Collin McNeese <cmcneese@chef.io>
2020-01-14 14:34:22 -06:00
Collin McNeese
78f9594839
updates file resource doc to add example for sticky bit with leading zero
...
Signed-off-by: Collin McNeese <cmcneese@chef.io>
2020-01-02 08:29:26 -06:00
Cameron Straka
8b037fa9c2
replaced instances of have_protocols
with have_protocol
in documentation and examples
...
Signed-off-by: Cameron Straka <strakacameron@hotmail.com>
2019-12-31 10:51:55 -05:00
Miah Johnson
e214cda8a7
Fixes #3430
...
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-12-03 19:28:10 -08:00
Mendy Baitelman
62faa1f03a
Add docs
...
Signed-off-by: Mendy Baitelman <mendy@baitelman.com>
2019-11-14 22:02:10 -08:00
Miah Johnson
e87a99ddd6
Merge pull request #4713 from inspec/cw/fix-windows-filesystem-doc-example
...
Correct filesystem resource docs for windows example
2019-11-13 12:34:50 -08:00
Clinton Wolfe
64676b2482
Correct filesystem resource docs for windows example
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-11-13 11:28:15 -05:00
Ryan Davis
b1c2af209b
Corresponding fixes for the move from test/unit/mock to test/fixtures.
...
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-11-08 19:20:12 -08:00
Ryan Davis
aeafaada51
Remove all aws doco.
...
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-11-05 16:04:48 -08:00
Ken Crouch
35d2b9c78a
Change "an Chef Inspec" to "a Chef Inspec".
...
Change "that users Ruby variables" to "that uses Ruby variables".
Obvious fix.
Signed-off-by: Ken Crouch <kcrouch@chef.io>
2019-11-01 14:12:33 -07:00
Mary Jinglewski
6064155a93
Docs Link Fixes
...
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-10-29 10:22:34 -04:00
Larry Eichenbaum
bd173b01e7
Update waivers.md
...
Adding DCO
Signed-off-by: Joe Smith <6776768+larryebaum@users.noreply.github.com>
Edited example to reflect correct input file structure for expiration.
2019-10-22 22:39:10 -07:00
Larry Eichenbaum
a7c73c4e13
Update waivers.md
...
Revise example text
2019-10-22 21:52:49 -07:00
Ryan Davis
c907a9114f
Update docs/dsl_resource.md
...
Co-Authored-By: mjingle <mjingle@users.noreply.github.com>
2019-10-21 12:35:09 -07:00
Ryan Davis
0620320d6e
Update docs/dsl_resource.md
...
Co-Authored-By: mjingle <mjingle@users.noreply.github.com>
2019-10-21 12:34:59 -07:00
Ryan Davis
3eaa64e5f1
Update Resource DSL doco to reflect lazy loading.
...
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-10-18 15:11:53 -07:00
Miah Johnson
df7efefc9d
mostly a search and replace for gordon -> example
...
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-10-16 10:13:24 -07:00
Clinton Wolfe
a9fd9c222a
Clarify docs about run: subfield
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-10-08 13:46:12 -07:00
Clinton Wolfe
0f5fde9729
Modify waiver input file to use 'run' subfield instead of 'skip'
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-10-08 01:03:40 -07:00
Miah Johnson
e48d08343b
Merge pull request #4452 from mhackethal/user-windows-fix
...
User windows fix
2019-10-04 15:30:37 -07:00
Miah Johnson
5a9e4ed1d5
Merge pull request #4509 from inspec/cw/add-compliance-subcommand-docs
...
Notes on compliance CLI subcommand
2019-10-04 15:28:45 -07:00
Clinton Wolfe
4ecea00644
Add tribal info about audit cookbook stubs
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-10-04 14:38:22 -04:00
Ryan Davis
0f05d7133e
Fixes based on feedback.
...
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-09-26 14:15:00 -07:00
Mary Jinglewski
be5e8d0a33
Edits and adding to website menu
...
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-09-26 16:56:06 -04:00
Ryan Davis
6e220d0310
Added first draft of waiver doco.
...
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-09-26 16:56:06 -04:00
Clinton Wolfe
47e3ed992f
Copyedit feedback
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-09-26 10:33:37 -04:00
Clinton Wolfe
3cc45920d1
broaden summary of tool purpose
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-09-20 17:24:12 -04:00
Clinton Wolfe
1e96e420d9
Writeup of compliance CLI subcommand
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-09-20 17:19:40 -04:00
mhackethal
56806b8f8f
Update documentation for user(s) resource. Signed-off-by: mhackethal <mh@it31.de>
2019-09-18 11:09:05 +02:00
Kerry Vance
729d9965ed
fails loudly with unsupported options
...
Signed-off-by: Kerry Vance <vancelot@osuosl.org>
2019-09-05 12:14:36 -07:00
Kerry Vance
3454c830a7
add documentation
...
Signed-off-by: Kerry Vance <vancelot@osuosl.org>
2019-09-05 11:56:13 -07:00
Clinton Wolfe
a6bd7ec4b5
Merge pull request #4401 from inspec/cw/input-from-cli
...
inputs: Accept bare input from the command line
2019-08-28 15:41:21 -04:00
Clinton Wolfe
2f9cd962b3
Docs grammo fix
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-08-28 13:25:49 -04:00
Clinton Wolfe
6a6bf2595c
docs for users and devs regarding reading the config elements from the config file
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-08-28 13:25:49 -04:00
Clinton Wolfe
569f459eba
Doc feedback
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-08-28 13:03:42 -04:00
Clinton Wolfe
c6ac67d6f5
Copyedit feedback
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-08-28 13:03:42 -04:00
Clinton Wolfe
9df36b0626
Update docs on inputs
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-08-28 13:03:42 -04:00
David Gasper
3912fef458
Add path example to docs
...
Signed-off-by: David Gasper <dmgasper@osuosl.org>
2019-08-08 14:22:39 -07:00
David Gasper
45556a0fdb
Update docs
...
Signed-off-by: David Gasper <dmgasper@osuosl.org>
2019-08-08 14:18:49 -07:00
David Gasper
52ae5e434b
Add docs and unit tests, remove .travis.yml
...
Signed-off-by: David Gasper <dmgasper@osuosl.org>
2019-08-08 13:54:35 -07:00
Clinton Wolfe
02fafa9bed
Merge pull request #4360 from kclinden/patch-1
...
Fixed typo in umask example
2019-08-08 13:13:27 -04:00
Ryan Davis
d5f63691d9
Fixed syntax errors in wmi doco.
...
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-08-07 13:01:43 -07:00
Kasey Linden
34275b8c11
Fixed typo in umask example
...
changed login_def to login_defs
2019-08-04 11:08:19 -05:00
Clinton Wolfe
0e32d2429f
Rename path_within_repo option to relative_path
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-07-30 13:36:20 -04:00
Clinton Wolfe
9c1fa967fd
Rename profile_path to path_within_repo
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-07-30 13:36:20 -04:00
Jerry Aldrich
3e1d08cafe
Add support for relative paths to the Git fetcher
...
This adds support for specifying a path to a profile in a Git repo.
For example, you could have a Git repo containing multiple profiles and
you want to specify a single one like below:
```yaml
depends:
- name: profile-1
git: https://github.com/myorg/all-my-profiles.git
profile_path: profiles/my-specific-profile-1
- name: profile-2
git: https://github.com/myorg/all-my-profiles.git
profile_path: profiles/my-specific-profile-2
```
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-07-30 13:36:20 -04:00
Clinton Wolfe
962ec0591e
Transition the Habitat plugin to use scaffolding ( #4320 )
...
Transition the Habitat plugin to use scaffolding
2019-07-29 12:50:49 -04:00
John Snow
bcd0189df1
Update docs/habitat.md
...
Co-Authored-By: mjingle <mjingle@users.noreply.github.com>
2019-07-26 17:11:15 -04:00
kekaichinose
e88468736a
Merge pull request #4314 from inspec/ja/add-shadow-example
...
Add SHA512 password example to `shadow` resource
2019-07-26 11:48:44 -07:00
John Snow
7fb4b8b14b
Remove scaffolding section in doc
...
Signed-off-by: John Snow <thelunaticscripter@outlook.com>
2019-07-22 17:10:40 -04:00
John Snow
bdf1b01af7
Make changes to doc after review
...
Signed-off-by: John Snow <thelunaticscripter@outlook.com>
2019-07-22 17:09:09 -04:00
John Snow
ea8c76dcd2
Update docs/habitat.md
...
Co-Authored-By: Jerry Aldrich <aldrich003@gmail.com>
2019-07-22 16:58:44 -04:00
John Snow
d223f63be5
Update docs/habitat.md
...
Co-Authored-By: Jerry Aldrich <aldrich003@gmail.com>
2019-07-22 16:57:55 -04:00
John Snow
a81dfc39fa
Update docs/habitat.md
...
Co-Authored-By: Jerry Aldrich <aldrich003@gmail.com>
2019-07-22 16:57:09 -04:00
John Snow
bbb809f703
Transition the Habitat plugin to use scaffolding
...
Signed-off-by: John Snow <thelunaticscripter@outlook.com>
2019-07-19 15:25:06 -04:00
Jerry Aldrich
74f0e7cf0e
Correct example to use message
in both places
...
Thanks @kclinden
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-07-18 10:06:59 -07:00
Jerry Aldrich
4a5103802a
Change comment to be correct and fit on one line
...
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-07-17 22:38:43 -07:00
Jerry Aldrich
a9879544a9
Add SHA512 password example to shadow
resource
...
Many thanks to @kclinden and @zenspider for helping make this possible
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-07-17 20:03:41 -07:00
Eike Waldt
68dd042bd0
use semi-realistic examples
...
Signed-off-by: Eike Waldt <waldt@b1-systems.de>
2019-07-16 21:02:52 +02:00
Eike Waldt
2a775ca6b7
indent all code samples in docs/resources/sys_info.md.erb
...
Signed-off-by: Eike Waldt <waldt@b1-systems.de>
2019-07-16 21:02:52 +02:00
Eike Waldt
2a072ad852
add docs for resource sys_info.manufacturer and sys_info.model
...
Signed-off-by: Eike Waldt <waldt@b1-systems.de>
2019-07-16 20:39:38 +02:00
Miah Johnson
1541879f0b
Merge pull request #4269 from shoekstra/users_docs_example
...
Add allowed users example to Users resource
2019-07-08 12:03:22 -07:00
Miah Johnson
8272d0184b
Merge pull request #4236 from ramereth/ip6tables
...
Add ip6tables resource
2019-07-08 11:45:33 -07:00
Stephen Hoekstra
c2b4bb878b
Add allowed users example to Users resource
...
This example shows how to check for expected users and to flag any other
users that should not be present.
Signed-off-by: Stephen Hoekstra <stephenhoekstra@gmail.com>
2019-07-08 20:30:20 +02:00
kekaichinose
352f149015
Update azure_resource_group.md.erb
...
* corrected documentation to reflect missing method of "_count" (correct) vs. "_counts" (wrong)
* corrected incorrect spelling of "Inspec" to "InSpec"
Signed-off-by: Keka Ichinose <rikoomi@hotmail.com>
2019-07-03 22:52:46 -07:00
Jerry Aldrich
b7eb0f370f
Add CLI target examples for Windows domain users
...
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-06-25 15:34:51 -07:00
Lance Albertson
3263d76627
Add ip6tables resource
...
This should resolve #1011 which provides an ip6tables resource to test IPv6
iptables rules. This is essentially a copy of the iptables resource with a few
renames.
In addition, I've pulled in the integration tests for iptables into ip6tables
and enabled it on docker so that it properly gets tested regularly. The test
cookbook recipe has been updated to support all of the current platforms that
are being tested.
Signed-off-by: Lance Albertson <lance@osuosl.org>
2019-06-24 17:01:34 -07:00
Clinton Wolfe
cc6faa49ce
Create Inputs documentation page ( #4185 )
...
Create Inputs documentation page
2019-06-12 13:26:39 -04:00
Clinton Wolfe
9eb7927c81
Replace semicolon
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-12 12:12:27 -04:00
Clinton Wolfe
425f13ef97
Mission-critical extra newline fix
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-06 15:26:37 -04:00
Clinton Wolfe
9366804335
PR Feedback
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-06 12:51:22 -04:00
Clinton Wolfe
93481a5814
Developer docs
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-06 12:51:22 -04:00
Clinton Wolfe
94bc98e32e
copyedit feedback
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-06 12:50:19 -04:00
Mary Jinglewski
cc9532d065
Copyediting for Input docs
...
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-06-05 16:54:47 -04:00
Clinton Wolfe
68fc434ede
Missed one
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 12:06:08 -04:00
Clinton Wolfe
aecd11b45c
Update related docs
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 11:14:35 -04:00
Clinton Wolfe
35b27ee109
Readover edits
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
896aca1ffd
Resolve TODOs
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
70ea81b245
bulk of text in place
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
213613d978
Add profile metadata section
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
97c62cf5fe
Add reading imputs section
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
e91f7a4ea8
Wrote out option reference
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
682fa18313
Most of introduction in place
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Clinton Wolfe
0bd3941aaa
outline of inputs doc
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-05 10:57:00 -04:00
Mary Jinglewski
8003305caf
Fixing docs so Warning note appears
...
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-06-04 13:44:41 -04:00
Clinton Wolfe
82cafccebb
Remove enclosing HTML and re-render
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-03 11:56:34 -04:00
Clinton Wolfe
3cb3ca9f94
Remove two misrendering hyperlinks
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-03 11:35:48 -04:00
Miah Johnson
2a1b1d8e88
Remove all leading newlines.
...
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-05-31 11:43:44 -07:00
Clinton Wolfe
06de2dc941
Update azure gr sunset notice
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-05-30 11:40:05 -04:00
Clinton Wolfe
c4d7a52b94
Update apache resource sunset notice
...
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-05-30 11:39:20 -04:00
Miah Johnson
2215bb0570
Update all require
s pointing to util/
...
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-05-28 11:30:16 -07:00
Ryan Davis
f36a7c8061
No tabs.
...
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-05-25 03:40:36 -07:00
Mary Jinglewski
3dec5dad3e
GCP InSpec Docs
...
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-05-21 16:45:02 -07:00
Miah Johnson
dafd91898d
Merge branch 'master' into changeInSpecText
2019-05-08 12:32:04 -07:00
Miah Johnson
5c00a44d71
Update resource registry_key documentation example
...
ref: https://github.com/inspec/inspec/issues/4003
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-04-30 17:04:12 -07:00
Unknown
5c1467dfe9
Update software name from InSpec to Chef Inspec
...
Signed-off-by: IanMadd <maddaus@protonmail.com>
2019-04-29 15:16:56 -04:00
Mary Jinglewski
70db730b48
Remove be_immutable
...
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-04-23 13:52:48 -04:00
Clinton Wolfe
3d0b8dff2e
Merge pull request #3956 from inspec/cw/use-deprecation-everywhere-4-port
...
Use deprecation facility everywhere - v4 port
2019-04-17 17:12:24 -04:00