From 8ff597effc3a53fde13778769121e419f6c3c78c Mon Sep 17 00:00:00 2001 From: Nima Fotouhi Date: Fri, 17 Nov 2023 15:52:46 -0800 Subject: [PATCH] fixed documentation broken links Signed-off-by: Nima Fotouhi --- {images => docs/images}/compliance_evaluation.png | Bin .../images}/config_change_triggered.jpeg | Bin {images => docs/images}/config_hybrid.jpeg | Bin {images => docs/images}/config_periodic.jpeg | Bin {images => docs/images}/lambda_logic1.png | Bin docs/index.md | 2 +- docs/rule-management/creating-rules.md | 6 +++--- .../rdk-lambda-function/lambda-function-logic.md | 2 +- mkdocs.yml | 2 +- 9 files changed, 6 insertions(+), 6 deletions(-) rename {images => docs/images}/compliance_evaluation.png (100%) rename {images => docs/images}/config_change_triggered.jpeg (100%) rename {images => docs/images}/config_hybrid.jpeg (100%) rename {images => docs/images}/config_periodic.jpeg (100%) rename {images => docs/images}/lambda_logic1.png (100%) diff --git a/images/compliance_evaluation.png b/docs/images/compliance_evaluation.png similarity index 100% rename from images/compliance_evaluation.png rename to docs/images/compliance_evaluation.png diff --git a/images/config_change_triggered.jpeg b/docs/images/config_change_triggered.jpeg similarity index 100% rename from images/config_change_triggered.jpeg rename to docs/images/config_change_triggered.jpeg diff --git a/images/config_hybrid.jpeg b/docs/images/config_hybrid.jpeg similarity index 100% rename from images/config_hybrid.jpeg rename to docs/images/config_hybrid.jpeg diff --git a/images/config_periodic.jpeg b/docs/images/config_periodic.jpeg similarity index 100% rename from images/config_periodic.jpeg rename to docs/images/config_periodic.jpeg diff --git a/images/lambda_logic1.png b/docs/images/lambda_logic1.png similarity index 100% rename from images/lambda_logic1.png rename to docs/images/lambda_logic1.png diff --git a/docs/index.md b/docs/index.md index 17d28df..ec316ed 100644 --- a/docs/index.md +++ b/docs/index.md @@ -164,7 +164,7 @@ rdk sample-ci to output a formatted JSON document. -For a deeper dive on how to create RDK rules visit [Creating Rules](./creating-and-editing-rules/creating-rules.md). +For a deeper dive on how to create RDK rules visit [Creating Rules](./rule-management/creating-rules.md). ### Write and Run Unit Tests diff --git a/docs/rule-management/creating-rules.md b/docs/rule-management/creating-rules.md index cd96782..2a77fff 100644 --- a/docs/rule-management/creating-rules.md +++ b/docs/rule-management/creating-rules.md @@ -56,13 +56,13 @@ Run `rdk create IAM_ROLE --runtime python3.11 --resource-types AWS::IAM::Role`. When you use `--resource-types or -r` options, you are implicitly setting your rule’s trigger type to configuration changes, so when you deploy this rule, you will see Oversized configuration changes and Configuration changes under Detective evaluation trigger type in your rule’s detail page on AWS Config console: -![configuration change triggered rule](../../images/config_change_triggered.jpeg) +![configuration change triggered rule](../images/config_change_triggered.jpeg) ### Creating a periodically triggered rule to assess IAM roles’ compliance Run `rdk create IAM_ROLE --runtime python3.11 --maximum-frequency Six_Hours`. Using the `-m, or --maximum-frequency` option, implicitly sets your rule’s trigger type to periodic, so when you deploy this rule, you will see Periodic: 6 hours under Detective evaluation trigger type in your rule’s detail page on AWS Config console: -![periodically triggered rule](../../images/config_periodic.jpeg) +![periodically triggered rule](../images/config_periodic.jpeg) Note that _Scope of Changes_ is empty because this is a periodically triggered role. @@ -76,4 +76,4 @@ Run `rdk create IAM_ROLE --runtime python3.11 --maximum-frequency Six_Hours --re This rule is triggered every six hours, and every time there is a change in _AWS::IAM::Role_ or _AWS::IAM::Policy_ resource types. When you deploy this rule you will see _Oversized configuration changes, Periodic: 6 hours_ and _Configuration changes_ under _Detective evaluation trigger type_ in your rule’s detail page on AWS Config console, you should also see two different resource types under _Resource types_: -![Hybrid rule with input parameters](../../images/config_hybrid.jpeg) +![Hybrid rule with input parameters](../images/config_hybrid.jpeg) diff --git a/docs/rule-management/rdk-lambda-function/lambda-function-logic.md b/docs/rule-management/rdk-lambda-function/lambda-function-logic.md index 9ada22a..baf4d54 100644 --- a/docs/rule-management/rdk-lambda-function/lambda-function-logic.md +++ b/docs/rule-management/rdk-lambda-function/lambda-function-logic.md @@ -34,7 +34,7 @@ Here are the highlights of what the lambda_handler function does: ### Validating compliance results, and reporting back to AWS Config -When you create your AWS Config rule files using `rdk create` command, your Lambda function file has an empty evaluate_compliance function which you need to populate with your compliance evaluation logic and return the compliance result (see the [Writing an evaluate_compliance function](Writing%20an%20evaluate_compliance%20function.md) for guidance on updating this function). Compliance results is expected to be a string, a dictionary or a list of dictionaries containing the following keys: +When you create your AWS Config rule files using `rdk create` command, your Lambda function file has an empty evaluate_compliance function which you need to populate with your compliance evaluation logic and return the compliance result (see the [Writing an evaluate_compliance function](writing-an-evaluate_compliance-function.md) for guidance on updating this function). Compliance results is expected to be a string, a dictionary or a list of dictionaries containing the following keys: - `ComplianceResourceType` - `ComplianceResourceId` diff --git a/mkdocs.yml b/mkdocs.yml index 3dfae0b..9dedd35 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,7 +3,7 @@ theme: name: material palette: scheme: default - primary: orange + primary: navy plugins: - search # TODO: Enable this if/when docstrings are expanded in the core rdk module.