From 98742bde62e00177cbe0ccd2674fa4631d87cece Mon Sep 17 00:00:00 2001 From: Nima Fotouhi Date: Tue, 21 Nov 2023 15:13:46 -0800 Subject: [PATCH] fix: documentation broken links Signed-off-by: Nima Fotouhi --- README.md | 6 +++--- docs/advanced-features/rulesets.md | 6 +++--- docs/index.md | 3 +-- docs/legacy-docs.md | 2 +- 4 files changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5594510..132d2e7 100644 --- a/README.md +++ b/README.md @@ -430,10 +430,10 @@ The above example would create files with config rule name as New as of version 0.3.11, it is possible to add RuleSet tags to rules that can be used to deploy and test groups of rules together. Rules can belong to multiple RuleSets, and RuleSet membership is stored only in -the parameters.json metadata. The [deploy]{.title-ref}, -[create-rule-template]{.title-ref}, and [test-local]{.title-ref} +the parameters.json metadata. The [deploy](docs/commands/deploy.md), +[create-rule-template](docs/commands/create-rule-template.md), and [test-local](docs/commands/test-local.md) commands are RuleSet-aware such that a RuleSet can be passed in as the -target instead of [--all]{.title-ref} or a specific named Rule. +target instead of `--all` or a specific named Rule. A comma-delimited list of RuleSets can be added to a Rule when you create it (using the `--rulesets` flag), as part of a `modify` command, diff --git a/docs/advanced-features/rulesets.md b/docs/advanced-features/rulesets.md index f795fe7..abf2cf3 100644 --- a/docs/advanced-features/rulesets.md +++ b/docs/advanced-features/rulesets.md @@ -3,10 +3,10 @@ New as of version 0.3.11, it is possible to add RuleSet tags to rules that can be used to deploy and test groups of rules together. Rules can belong to multiple RuleSets, and RuleSet membership is stored only in -the parameters.json metadata. The [deploy]{.title-ref}, -[create-rule-template]{.title-ref}, and [test-local]{.title-ref} +the parameters.json metadata. The [deploy](../commands/deploy.md), +[create-rule-template](../commands/create-rule-template.md), and [test-local](../commands/test-local.md) commands are RuleSet-aware such that a RuleSet can be passed in as the -target instead of [--all]{.title-ref} or a specific named Rule. +target instead of `--all` or a specific named Rule. A comma-delimited list of RuleSets can be added to a Rule when you create it (using the `--rulesets` flag), as part of a `modify` command, diff --git a/docs/index.md b/docs/index.md index ec316ed..515f407 100644 --- a/docs/index.md +++ b/docs/index.md @@ -211,8 +211,7 @@ if this is something you want! This project is maintained by AWS Solution Architects and Consultants. It is not part of an AWS service and support is provided best-effort by the maintainers. To post feedback, submit feature ideas, or report bugs, -please use the [Issues -section](https://github.com/awslabs/aws-config-rdk/issues) of this repo. +please use the [Issues section](https://github.com/awslabs/aws-config-rdk/issues) of this repo. ## Contributing diff --git a/docs/legacy-docs.md b/docs/legacy-docs.md index d7bba05..1bb1296 100644 --- a/docs/legacy-docs.md +++ b/docs/legacy-docs.md @@ -150,7 +150,7 @@ there will be a `_test.py` file deployed along with your Lambda function skeleton. This can be used to write unit tests according to the standard Python unittest framework (documented here: ), which can be run -using the [test-local]{.title-ref} rdk command: +using the [test-local](./commands/test-local.md) rdk command: rdk test-local MyTestRule Running local test!