Skip to content

Commit 1f99a28

Browse files
committed
Edit mongodb resource docs
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
1 parent 402d478 commit 1f99a28

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

docs-chef-io/content/_index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "About Chef InSpec MongoDB resources"
33
platform = "mongodb"
44
draft = false
55
linkTitle = "MongoDB resources"
6-
summary = "Chef InSpec resources for auditing MongoDB"
6+
summary = "Chef InSpec resources for auditing MongoDB databases and configurations"
77

88

99
[cascade]
@@ -17,20 +17,22 @@ identifier = "inspec/resources/mongodb/about"
1717
parent = "inspec/resources/mongodb"
1818
+++
1919

20-
The Chef InSpec MongoDB resources allow you to audit a MongoDB database or configuration file.
20+
The Chef InSpec MongoDB resources allow you to audit MongoDB database configurations, user permissions, and security settings.
2121

2222
## Support
2323

24-
The InSpec MongoDB resources were part of InSpec core through InSpec 6.
25-
Starting in InSpec 7, they're released separately as a Ruby gem.
24+
The InSpec MongoDB resources are supported in the following InSpec versions:
2625

27-
## Usage
26+
- InSpec 6 and earlier: MongoDB resources were included in the InSpec core installation
27+
- InSpec 7 and later: MongoDB resources are distributed as the separate `inspec-mongodb-resources` gem
28+
29+
### Add to your InSpec profile
2830

2931
To add this resource pack to an InSpec profile, add the `inspec-mongodb-resources` gem as a dependency in your `inspec.yml` file:
3032

3133
```yaml
3234
depends:
33-
- name: inspec-mongodb-resources
35+
- name: inspec-mongodb-resources
3436
gem: inspec-mongodb-resources
3537
```
3638

docs-chef-io/content/mongodb_conf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ end
5757

5858
## Matchers
5959

60-
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
60+
{{< readfile file="content/reusable/md/inspec_matchers_link.md" >}}

docs-chef-io/content/mongodb_session.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ end
107107

108108
## Matchers
109109

110-
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
110+
{{< readfile file="content/reusable/md/inspec_matchers_link.md" >}}
111111

112112
This resource has the following special matchers.
113113

0 commit comments

Comments
 (0)