docs: improving resource documentation

Author: ekristen

docs/resources/ec2-image.md

@@ -0,0 +1,36 @@
+# EC2 Image
+
+This will remove all IAM Roles an AWS account.
+
+## Resource
+
+```text
+EC2Image
+```
+
+## Settings
+
+- `IncludeDisabled`
+- `IncludeDeprecated`
+- `DisableDeregistrationProtection`
+
+### IncludeDisabled
+
+This will include any EC2 Images (AMI) that are disabled in the deletion process. By default, disabled images are excluded
+from the discovery process.
+
+Default is `false`.
+
+### IncludeDeprecated
+
+This will include any EC2 Images (AMI) that are deprecated in the deletion process. By default, deprecated images are excluded
+from the discovery process.
+
+Default is `false`.
+
+### DisableDeregistrationProtection
+
+This will disable the deregistration protection on the EC2 Image (AMI) prior to deletion. By default, deregistration protection
+is not disabled.
+
+Default is `false`.

docs/resources/iam-role.md

@@ -2,6 +2,12 @@
 
 This will remove all IAM Roles an AWS account.
 
+## Resource
+
+```text
+IAMRole
+```
+
 ## Settings
 
 - `IncludeServiceLinkedRoles`

docs/resources/overview.md

@@ -0,0 +1,5 @@
+# Resources Overview
+
+This is the start of the documentation for all resources handled by aws-nuke. Eventually each resource will have its own
+page with detailed information on how to use it, what settings are available, and what the resource does.
+

docs/resources/s3-bucket.md

@@ -13,6 +13,12 @@ This will remove all S3 buckets from an AWS account. The following actions are p
   - This will include bypassing any Object Lock governance retention settings if the `BypassGovernanceRetention`
     setting is set to `true`
 
+## Resource
+
+```text
+S3Bucket
+```
+
 ## Settings
 
 - `BypassGovernanceRetention` 

docs/resources/s3-object.md

@@ -0,0 +1,22 @@
+# S3Object
+
+!!! warning
+    **You should exclude this resource by default.** Not doing so can lead to deadlocks and hung runs of the tool. In 
+    the next major version of aws-nuke, this resource will be excluded by default.
+
+!!! important
+    This resource is **NOT** required to remove a [S3Bucket](./s3-bucket.md). The `S3Bucket` resource will remove all
+    objects in the bucket as part of the deletion process using a batch removal process.
+
+This removes all objects from S3 buckets in an AWS account while retaining the S3 bucket itself. This resource is
+useful if you want to remove a single object from a bucket, or a subset of objects without removing the entire bucket.
+
+## Resource
+
+```text
+S3Object
+```
+
+## Settings
+
+**No settings available.**

mkdocs.yml

@@ -92,9 +92,12 @@ nav:
     - Custom Endpoints: config-custom-endpoints.md
     - Migration Guide: config-migration.md
   - Resources:
+    - Overview: resources/overview.md
     - Cognito User Pool: resources/cognito-user-pool.md
+    - EC2 Image: resources/ec2-image.md
     - IAM Role: resources/iam-role.md
     - S3 Bucket: resources/s3-bucket.md
+    - S3 Object: resources/s3-object.md
   - Development:
     - Overview: development.md
     - Contributing: contributing.md