Skip to content

Commit

Permalink
docs: several minor fixes to the docs (#4369)
Browse files Browse the repository at this point in the history
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the Apache 2.0 License.
  • Loading branch information
Lou1415926 authored Jan 13, 2023
1 parent f3be33a commit 5249136
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions site/content/docs/developing/addons/package.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions site/content/docs/developing/addons/package.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) プロパティを追加します。
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/include/network.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<span class="parent-field">network.</span><a id="network-connect-alias" href="#network-connect-alias" class="field">`alias`</a> <span class="type">String</span>
<span class="parent-field">network.connect.</span><a id="network-connect-alias" href="#network-connect-alias" class="field">`alias`</a> <span class="type">String</span>
A custom DNS name for this service exposed to Service Connect. Defaults to the service name.

<span class="parent-field">network.</span><a id="network-vpc" href="#network-vpc" class="field">`vpc`</a> <span class="type">Map</span>
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/include/network.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Service に対し [Service Connect](../developing/svc-to-svc-communication.ja.md

Map として利用すると、Service で利用するエリアスを指定出来ます。エリアスは Environment 内でユニークである必要があります。

<span class="parent-field">network.</span><a id="network-connect-alias" href="#network-connect-alias" class="field">`alias`</a> <span class="type">String</span>
<span class="parent-field">network.connect.</span><a id="network-connect-alias" href="#network-connect-alias" class="field">`alias`</a> <span class="type">String</span>
Service Connect 経由で公開する Service のカスタム DNS 名です。デフォルトは Service 名です。

<span class="parent-field">network.</span><a id="network-vpc" href="#network-vpc" class="field">`vpc`</a> <span class="type">Map</span>
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/lb-web-service.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ http:
hosted_zone: AN0THE9H05TED20NEID
```
<span class="parent-field">http.</span><a id="http-hosted-zone" href="#http-hosted-zone" class="field">`hosted_zone`</a> <span class="type">String</span>
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
Expand Down

0 comments on commit 5249136

Please sign in to comment.