Skip to content

Commit

Permalink
docs(core): fix broken links to design guidelines (#9158)
Browse files Browse the repository at this point in the history
  • Loading branch information
Chriscbr authored Jul 20, 2020
1 parent cb5dad8 commit c5a66c8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
9 changes: 4 additions & 5 deletions packages/awslint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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[*]]
Expand Down Expand Up @@ -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.

0 comments on commit c5a66c8

Please sign in to comment.