Skip to content

Commit

Permalink
docs: code highlighting and spacing (#3656)
Browse files Browse the repository at this point in the history
`taskdef-overrides.md` has different changes (spacing) than the rest that are fixing/removing code highlighting.

Current:
![Screen Shot 2022-06-10 at 16 13 22](https://user-images.githubusercontent.com/10566468/173161505-ffef9592-b072-4a0d-b312-64a7f62f6ed2.png)


New:
![Screen Shot 2022-06-10 at 16 13 28](https://user-images.githubusercontent.com/10566468/173161547-e34f01c8-72af-4bcc-84f6-1a4b77258034.png)



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
dannyrandall authored Jun 13, 2022
1 parent 4792887 commit 1a7759c
Show file tree
Hide file tree
Showing 84 changed files with 287 additions and 287 deletions.
6 changes: 3 additions & 3 deletions site/content/docs/commands/app-delete.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# app delete
```bash
```console
$ copilot app delete [flags]
```

Expand All @@ -9,13 +9,13 @@ $ copilot app delete [flags]

## What are the flags?

```bash
```
-h, --help help for delete
--yes Skips confirmation prompt.
```

## Examples
Force delete the application.
```bash
```console
$ copilot app delete --yes
```
6 changes: 3 additions & 3 deletions site/content/docs/commands/app-delete.ja.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# app delete
```bash
```console
$ copilot app delete [flags]
```

Expand All @@ -9,13 +9,13 @@ $ copilot app delete [flags]

## フラグ

```bash
```
-h, --help help for delete
--yes Skips confirmation prompt.
```

## 実行例
Application を強制的に削除します。
```bash
```console
$ copilot app delete --yes
```
10 changes: 5 additions & 5 deletions site/content/docs/commands/app-init.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# app init
```bash
```console
$ copilot app init [name] [flags]
```

Expand All @@ -12,7 +12,7 @@ Typically, you don't need to run `app init` (`init` does all the same work) unle

## What are the flags?
Like all commands in the Copilot CLI, if you don't provide required flags, we'll prompt you for all the information we need to get you going. You can skip the prompts by providing information via flags:
```bash
```
--domain string Optional. Your existing custom domain name.
-h, --help help for init
--resource-tags stringToString Optional. Labels with a key and value separated by commas.
Expand All @@ -25,15 +25,15 @@ For example: `copilot app init --resource-tags department=MyDept,team=MyTeam`

## Examples
Create a new application named "my-app".
```bash
```console
$ copilot app init my-app
```
Create a new application with an existing domain name in Amazon Route53.
```bash
```console
$ copilot app init --domain example.com
```
Create a new application with resource tags.
```bash
```console
$ copilot app init --resource-tags department=MyDept,team=MyTeam
```
## What does it look like?
Expand Down
10 changes: 5 additions & 5 deletions site/content/docs/commands/app-init.ja.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# app init
```bash
```console
$ copilot app init [name] [flags]
```

Expand All @@ -14,7 +14,7 @@ $ copilot app init [name] [flags]
## フラグ
Copilot CLI における全てのコマンドと同じ様に、必要なフラグを指定しなかった場合、必要な情報を全て入力する様に求められます。
フラグを指定して情報を指定すると、プロンプトをスキップできます。
```bash
```
--domain string Optional. Your existing custom domain name.
-h, --help help for init
--resource-tags stringToString Optional. Labels with a key and value separated by commas.
Expand All @@ -29,15 +29,15 @@ Copilot CLI における全てのコマンドと同じ様に、必要なフラ

## 実行例
"my-app"という名前の新しい Application を作成します。
```bash
```console
$ copilot app init my-app
```
Route 53 に登録済みの既存ドメイン名を利用して新しい Application を作成します。
```bash
```console
$ copilot app init --domain example.com
```
リソースタグを指定して新しい Application を作成します。
```bash
```console
$ copilot app init --resource-tags department=MyDept,team=MyTeam
```
## 出力例
Expand Down
6 changes: 3 additions & 3 deletions site/content/docs/commands/app-ls.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# app ls
```bash
```console
$ copilot app ls [flags]
```

Expand All @@ -9,13 +9,13 @@ $ copilot app ls [flags]

## What are the flags?

```bash
```
-h, --help help for ls
```

## Examples
List all the applications in your account and region.
```bash
```console
$ copilot app ls
```

Expand Down
6 changes: 3 additions & 3 deletions site/content/docs/commands/app-ls.ja.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# app ls
```bash
```console
$ copilot app ls [flags]
```

Expand All @@ -9,13 +9,13 @@ $ copilot app ls [flags]

## フラグ

```bash
```
-h, --help help for ls
```

## 実行例
AWS アカウント、リージョンにある全ての Application を一覧表示します。
```bash
```console
$ copilot app ls
```

Expand Down
6 changes: 3 additions & 3 deletions site/content/docs/commands/app-show.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# app show
```bash
```console
$ copilot app show [flags]
```

Expand All @@ -9,15 +9,15 @@ $ copilot app show [flags]

## What are the flags?

```bash
```
-h, --help help for show
--json Optional. Outputs in JSON format.
-n, --name string Name of the application.
```

## Examples
Shows info about the application "my-app".
```bash
```console
$ copilot app show -n my-app
```

Expand Down
6 changes: 3 additions & 3 deletions site/content/docs/commands/app-show.ja.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# app show
```bash
```console
$ copilot app show [flags]
```

Expand All @@ -9,15 +9,15 @@ $ copilot app show [flags]

## フラグ

```bash
```
-h, --help help for show
--json Optional. Outputs in JSON format.
-n, --name string Name of the application.
```

## 実行例
"my-app"という Application に関する情報を出力します。
```bash
```console
$ copilot app show -n my-app
```

Expand Down
6 changes: 3 additions & 3 deletions site/content/docs/commands/app-upgrade.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# app upgrade
```bash
```console
$ copilot app upgrade [flags]
```

Expand All @@ -9,13 +9,13 @@ $ copilot app upgrade [flags]

## What are the flags?

```bash
```
-h, --help help for upgrade
-n, --name string Name of the application.
```

## Examples
Upgrade the application "my-app" to the latest version
```bash
```console
$ copilot app upgrade -n my-app
```
6 changes: 3 additions & 3 deletions site/content/docs/commands/app-upgrade.ja.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# app upgrade
```bash
```console
$ copilot app upgrade [flags]
```

Expand All @@ -9,13 +9,13 @@ $ copilot app upgrade [flags]

## フラグ

```bash
```
-h, --help help for upgrade
-n, --name string Name of the application.
```

## 実行例
Application "my-app" を最新バージョンにアップグレードします。
```bash
```console
$ copilot app upgrade -n my-app
```
12 changes: 6 additions & 6 deletions site/content/docs/commands/completion.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# completion
```
```console
$ copilot completion [shell] [flags]
```

Expand All @@ -9,30 +9,30 @@ $ copilot completion [shell] [flags]
See the help menu for instructions on how to setup auto-completion for your respective shell.

## What are the flags?
```bash
```
-h, --help help for completion
```

## Examples
Install zsh completion.
```bash
```console
$ source <(copilot completion zsh)
$ copilot completion zsh > "${fpath[1]}/_copilot" # to autoload on startup
```
Install bash completion on macOS using homebrew.
```bash
```console
$ brew install bash-completion # if running 3.2
$ brew install bash-completion@2 # if running Bash 4.1+
$ copilot completion bash > /usr/local/etc/bash_completion.d
```
Install bash completion on linux
```bash
```console
$ source <(copilot completion bash)
$ copilot completion bash > copilot.sh
$ sudo mv copilot.sh /etc/bash_completion.d/copilot
```
Install fish completion on linux
```bash
```console
$ source <(copilot completion fish)
$ copilot completion fish > ~/.config/fish/completions/copilot.fish
```
12 changes: 6 additions & 6 deletions site/content/docs/commands/completion.ja.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# completion
```
```console
$ copilot completion [shell] [flags]
```

Expand All @@ -9,30 +9,30 @@ $ copilot completion [shell] [flags]
それぞれのシェルで自動補完を設定する方法については、ヘルプメニューを参照してください。

## フラグ
```bash
```
-h, --help help for completion
```

##
zsh の補完をインストールします。
```bash
```console
$ source <(copilot completion zsh)
$ copilot completion zsh > "${fpath[1]}/_copilot" # to autoload on startup
```
bash の補完を homebrew を使って macOS にインストールします。
```bash
```console
$ brew install bash-completion # if running 3.2
$ brew install bash-completion@2 # if running Bash 4.1+
$ copilot completion bash > /usr/local/etc/bash_completion.d
```
bash の補完を Linux にインストールします。
```bash
```console
$ source <(copilot completion bash)
$ copilot completion bash > copilot.sh
$ sudo mv copilot.sh /etc/bash_completion.d/copilot
```
fish の補完を Linux にインストールします。
```bash
```console
$ source <(copilot completion fish)
$ copilot completion fish > ~/.config/fish/completions/copilot.fish
```
8 changes: 4 additions & 4 deletions site/content/docs/commands/deploy.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# copilot deploy
```
```console
$ copilot deploy
```

Expand All @@ -15,7 +15,7 @@ This command is used to run either [`copilot svc deploy`](../commands/svc-deploy

## What are the flags?

```bash
```
-a, --app string Name of the application.
-e, --env string Name of the environment.
--force Optional. Force a new service deployment using the existing image.
Expand All @@ -38,11 +38,11 @@ rollback of the stack via the AWS console or AWS CLI before the next deployment.
## Examples

Deploys a service named "frontend" to a "test" environment.
```bash
```console
$ copilot deploy --name frontend --env test
```

Deploys a job named "mailer" with additional resource tags to a "prod" environment.
```bash
```console
$ copilot deploy -n mailer -e prod --resource-tags source/revision=bb133e7,deployment/initiator=manual
```
Loading

0 comments on commit 1a7759c

Please sign in to comment.