From 5249136a7336264c5f837efe736d74472f77d698 Mon Sep 17 00:00:00 2001 From: Wanxian Yang <79273084+Lou1415926@users.noreply.github.com> Date: Fri, 13 Jan 2023 16:41:49 -0600 Subject: [PATCH] docs: several minor fixes to the docs (#4369) By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the Apache 2.0 License. --- mkdocs.yml | 2 +- site/content/docs/developing/addons/package.en.md | 4 ++-- site/content/docs/developing/addons/package.ja.md | 4 ++-- site/content/docs/include/network.en.md | 2 +- site/content/docs/include/network.ja.md | 2 +- site/content/docs/manifest/lb-web-service.en.md | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 252d7161d49..621686ca217 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,11 +40,11 @@ nav: - Manifest: - Overview: docs/manifest/overview.en.md - Backend Service: docs/manifest/backend-service.en.md - - Environment: docs/manifest/environment.en.md - Load Balanced Web Service: docs/manifest/lb-web-service.en.md - Request-Driven Web Service: docs/manifest/rd-web-service.en.md - Scheduled Job: docs/manifest/scheduled-job.en.md - Worker Service: docs/manifest/worker-service.en.md + - Environment: docs/manifest/environment.en.md - Pipeline: docs/manifest/pipeline.en.md - Developing: - Additional AWS Resources: diff --git a/site/content/docs/developing/addons/package.en.md b/site/content/docs/developing/addons/package.en.md index bb2fd9c89a4..b34e2d05b7a 100644 --- a/site/content/docs/developing/addons/package.en.md +++ b/site/content/docs/developing/addons/package.en.md @@ -62,10 +62,10 @@ Absolute paths are supported as well, though they may not work as well across mu This example will walk through creating an [Amazon Dynamo DB](https://aws.amazon.com/dynamodb/) table with a lambda function connected to process events from the [table's stream](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html). This architecture could be useful if you have a service that needs to minimize latency on storing data, but can kick off a separate process that takes longer to process the data. -#### Prerequesites: +#### Prerequisites - [A deployed copilot service](../../concepts/services.en.md) -#### Steps: +#### Steps 1. Generate a DynamoDB table addon for your service by running `copilot storage init` (More info [here!](../storage.en.md)) 2. Add the [`StreamSpecification`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-streamspecification) property to the generated [`AWS::DynamoDB::Table`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html) resource: ```yaml title="copilot/service-name/addons/ddb.yml" diff --git a/site/content/docs/developing/addons/package.ja.md b/site/content/docs/developing/addons/package.ja.md index 78b1d439e64..6059dd635f8 100644 --- a/site/content/docs/developing/addons/package.ja.md +++ b/site/content/docs/developing/addons/package.ja.md @@ -63,10 +63,10 @@ zip が必要な一部のリソース (`AWS::Serverless::Function` など) で このアーキテクチャは、データを保存する際のレイテンシを最小にする必要がある Service がある場合に便利ですが、データを処理するのに時間がかかる別のプロセスをキックオフすることができます。 -#### 前提条件: +#### 前提条件 - [デプロイされた Copilot Service](../../concepts/services.ja.md) -#### 手順: +#### 手順 1. `copilot storage init` を実行して、Service 用の DynamoDB テーブル Addon を生成します。(詳細は[こちら](../storage.ja.md)) 2. 生成された [`AWS::DynamoDB::Table`](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html) リソースに [`StreamSpecification`](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-streamspecification) プロパティを追加します。 diff --git a/site/content/docs/include/network.en.md b/site/content/docs/include/network.en.md index e9a2257e08a..d792ff53f3f 100644 --- a/site/content/docs/include/network.en.md +++ b/site/content/docs/include/network.en.md @@ -8,7 +8,7 @@ Enable [Service Connect](../developing/svc-to-svc-communication.en.md#service-co When using it as a map, you can specify which alias to use for this service. Note that the alias must be unique within the environment. -network.`alias` String +network.connect.`alias` String A custom DNS name for this service exposed to Service Connect. Defaults to the service name. network.`vpc` Map diff --git a/site/content/docs/include/network.ja.md b/site/content/docs/include/network.ja.md index b67859e46c3..86f7ea21001 100644 --- a/site/content/docs/include/network.ja.md +++ b/site/content/docs/include/network.ja.md @@ -8,7 +8,7 @@ Service に対し [Service Connect](../developing/svc-to-svc-communication.ja.md Map として利用すると、Service で利用するエリアスを指定出来ます。エリアスは Environment 内でユニークである必要があります。 -network.`alias` String +network.connect.`alias` String Service Connect 経由で公開する Service のカスタム DNS　名です。デフォルトは Service 名です。 network.`vpc` Map diff --git a/site/content/docs/manifest/lb-web-service.en.md b/site/content/docs/manifest/lb-web-service.en.md index 6989ecb798b..79c703fad7c 100644 --- a/site/content/docs/manifest/lb-web-service.en.md +++ b/site/content/docs/manifest/lb-web-service.en.md @@ -287,7 +287,7 @@ http: hosted_zone: AN0THE9H05TED20NEID ``` http.`hosted_zone` String -ID of your existing hosted zone; must be used with `http.alias`. If you have an environment with imported certificates, you can specify the hosted zone into which Copilot should insert the A record once the load balancer is created. +ID of your existing hosted zone; can only be used with `http.alias`. If you have an environment with imported certificates, you can specify the hosted zone into which Copilot should insert the A record once the load balancer is created. ```yaml http: alias: example.com