From c5a66c8de97b76584b74185ba1c3c716d726ab9a Mon Sep 17 00:00:00 2001 From: Christopher Rybicki Date: Mon, 20 Jul 2020 05:47:27 -0400 Subject: [PATCH] docs(core): fix broken links to design guidelines (#9158) --- CONTRIBUTING.md | 4 ++-- packages/awslint/README.md | 9 ++++----- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21469506518de..bcf045935ed0e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -361,14 +361,14 @@ $ lr pkglint **awslint** is a linter for the AWS Construct Library APIs. It is executed as a part of the build of all AWS modules in the project and enforces the [AWS -Construct Library Design Guidelines](./design/aws-guidelines.md). +Construct Library Design Guidelines](./DESIGN_GUIDELINES.md). For more information about this tool, see the [awslint README](./tools/awslint/README.md). Generally speaking, if you make any changes which violate an awslint rule, build will fail with appropriate messages. All rules are documented and explained in -the [guidelines](./design/aws-guidelines.md). +the [guidelines](./DESIGN_GUIDELINES.md). Here are a few useful commands: diff --git a/packages/awslint/README.md b/packages/awslint/README.md index f69074a1f0ab0..126a50884297b 100644 --- a/packages/awslint/README.md +++ b/packages/awslint/README.md @@ -12,7 +12,7 @@ A linter for the AWS Construct Library's API. It reflects a construct library's module via it's `.jsii` manifest and checks that the module adheres to the [AWS -Resource Construct Design Guidelines](../../design/aws-guidelines.md). +Resource Construct Design Guidelines](../../DESIGN_GUIDELINES.md). ## Usage @@ -69,7 +69,6 @@ $ npm run awslint -- -i resource-props -i import $ npm run awslint -- -i import -x "*:@aws-cdk/aws-s3*" ``` - Filters are specified using the following pattern: rule[*][:scope[*]] @@ -135,6 +134,6 @@ resource-class: every resource must have a resource class (L2) ... ``` -The [AWS Resource Construct Design Guidelines](../../design/aws-guidelines.md) document -includes references for all rules. For example, see [#resource-class](../../design/aws-guidelines.md#resource-class) -for a discussion about the "resource-class" rule. +The [AWS Resource Construct Design Guidelines](../../DESIGN_GUIDELINES.md) document +includes references for all rules. For example, see [#construct-interface](../../DESIGN_GUIDELINES.md#construct-interface) +for a discussion about the "construct-interface" rule.