Merge pull request #290 from kmcquade/docs/add-minimization-library-to-docs

Update docs on minimization

Author: kmcquade

docs/library-usage/writing/minimize.md

@@ -0,0 +1,15 @@
+Policy Minimization
+===================
+
+The documentation on policy minimization is relevant to this library content. That documentation can be found [here](https://policy-sentry.readthedocs.io/en/latest/writing-policies/minimization/).
+
+Note: The most relevant content from here is the `minimize_statement_actions` function.
+
+Real-life usage of this function can be found in the `command.write_policy` module.
+
+## writing.minimize
+
+::: policy_sentry.writing.minimize
+    rendering:
+      show_source: true
+

docs/writing-policies/minimization.md

@@ -49,52 +49,35 @@ wildcard-only:
 policy_sentry write-policy --input-file crud.yml --minimize 0
 ```
 
-The output has **749 characters** (not counting whitespaces) and will look like this:
+The output has **500 characters** (not counting whitespaces) and will look like this:
 
 ```json
 {
     "Version": "2012-10-17",
     "Statement": [
         {
-            "Sid": "SsmReadParameter",
+            "Sid": "SsmMultParametermyparameter",
             "Effect": "Allow",
             "Action": [
                 "ssm:getpar*",
-                "ssm:listt*"
-            ],
-            "Resource": [
-                "arn:aws:ssm:us-east-1:123456789012:parameter/myparameter"
-            ]
-        },
-        {
-            "Sid": "SsmWriteParameter",
-            "Effect": "Allow",
-            "Action": [
                 "ssm:deletepar*",
                 "ssm:la*",
-                "ssm:putp*"
+                "ssm:putp*",
+                "ssm:listt*"
             ],
             "Resource": [
                 "arn:aws:ssm:us-east-1:123456789012:parameter/myparameter"
             ]
         },
         {
-            "Sid": "SecretsmanagerPermissionsmanagementSecret",
-            "Effect": "Allow",
-            "Action": [
-                "secretsmanager:deleter*",
-                "secretsmanager:putr*"
-            ],
-            "Resource": [
-                "arn:aws:secretsmanager:us-east-1:123456789012:secret:mysecret"
-            ]
-        },
-        {
-            "Sid": "SecretsmanagerTaggingSecret",
+            "Sid": "SecretsmanagerMultSecretmysecret",
             "Effect": "Allow",
             "Action": [
                 "secretsmanager:t*",
-                "secretsmanager:un*"
+                "secretsmanager:un*",
+                "secretsmanager:deleter*",
+                "secretsmanager:putr*",
+                "secretsmanager:v*"
             ],
             "Resource": [
                 "arn:aws:secretsmanager:us-east-1:123456789012:secret:mysecret"
@@ -115,7 +98,11 @@ policy_sentry write-policy --input-file crud.yml
 
 * The output has **935 characters** and will look like this:
 
-```json
+<details open>
+<summary>policy_sentry query action-table --service all</summary>
+<br>
+<pre>
+<code>
 {
     "Version": "2012-10-17",
     "Statement": [
@@ -170,7 +157,9 @@ policy_sentry write-policy --input-file crud.yml
         }
     ]
 }
-```
+</code>
+</pre>
+</details>
 
 
 ## Conclusion

mkdocs.yml

@@ -54,9 +54,10 @@ nav:
   - "<b>Library Reference</b>":
     - Overview: 'library-usage/index.md'
     - "<b>Writing Policies</b>":
-      - command.write_policy: 'library-usage/writing/write_policy.md'
-      - writing.validate: 'library-usage/writing/validate.md'
+      - writing.minimize: 'library-usage/writing/minimize.md'
       - writing.sid_group: 'library-usage/writing/sid_group.md'
+      - writing.validate: 'library-usage/writing/validate.md'
+      - command.write_policy: 'library-usage/writing/write_policy.md'
     - "<b>Querying the Database</b>":
       - querying.all: 'library-usage/querying/all.md'
       - querying.actions: 'library-usage/querying/actions.md'