diff --git a/packages/@aws-cdk/aws-service-spec/README.md b/packages/@aws-cdk/aws-service-spec/README.md index a43ec1d08..bc3325acc 100644 --- a/packages/@aws-cdk/aws-service-spec/README.md +++ b/packages/@aws-cdk/aws-service-spec/README.md @@ -8,6 +8,7 @@ Sometimes it is necessary to patch in certain aspects of the CloudFormation sche properly configured for our use cases. As such, we'll need to create a patch. You can create a patch by following these steps: + 1. Create a new patch file under `build/patches/service-patches/my-module.ts` (or use one of the existing patch files if it is for the same module). 2. If you created a new file, add it to `build/patches/service-patches/index.ts`. diff --git a/packages/@aws-cdk/service-spec-importers/README.md b/packages/@aws-cdk/service-spec-importers/README.md index bf1f3aec2..520e9b310 100644 --- a/packages/@aws-cdk/service-spec-importers/README.md +++ b/packages/@aws-cdk/service-spec-importers/README.md @@ -53,7 +53,7 @@ Options: -r, --report Create a detailed build report in the specified directory -v, --validate Validate imported sources and fail if any data is invalid (default: false) -h, --help display help for command -```` +``` ## Sources @@ -88,5 +88,5 @@ CloudFormationSchema/ CLI: `samSchema`\ Code: `importSamJsonSchema(filePath: string)` -Import the (modern) JSON schema spec from SAM. +Import the (modern) JSON Schema Spec from SAM. Path to a single file containing a SAM Registry Schema. diff --git a/packages/@aws-cdk/service-spec-types/README.md b/packages/@aws-cdk/service-spec-types/README.md index 460a1524e..90ffc30df 100644 --- a/packages/@aws-cdk/service-spec-types/README.md +++ b/packages/@aws-cdk/service-spec-types/README.md @@ -1,6 +1,6 @@ # @aws-cdk/service-spec-types -Types and utils for CloudFormation Service Specifications +Types and utils for CloudFormation Service Specifications. ```ts import { emptyDatabase, SpecDatabase } from '@aws-cdk/service-spec-types';