From d2338009878d875434f500c2fc61f8721282913f Mon Sep 17 00:00:00 2001 From: git823 Date: Sat, 25 Jul 2020 12:56:34 +0900 Subject: [PATCH 1/3] docs: add missing document for copilot env show command. Wiki page has the document for copilot env show command, but there is no file related to it in this repository. Adding markdown based on wiki's one, --- site/content/en/docs/Commands/env/_index.md | 2 +- site/content/en/docs/Commands/env/delete.md | 2 +- site/content/en/docs/Commands/env/show.md | 27 +++++++++++++++++++++ 3 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 site/content/en/docs/Commands/env/show.md diff --git a/site/content/en/docs/Commands/env/_index.md b/site/content/en/docs/Commands/env/_index.md index 103fbd144b0..ac63a5ee36d 100644 --- a/site/content/en/docs/Commands/env/_index.md +++ b/site/content/en/docs/Commands/env/_index.md @@ -1,7 +1,7 @@ --- title: "env" linkTitle: "env" -weight: 3 +weight: 4 expand: true --- Commands for environments. diff --git a/site/content/en/docs/Commands/env/delete.md b/site/content/en/docs/Commands/env/delete.md index 6dc181e5f50..5e1fe2ca72a 100644 --- a/site/content/en/docs/Commands/env/delete.md +++ b/site/content/en/docs/Commands/env/delete.md @@ -1,7 +1,7 @@ --- title: "env delete" linkTitle: "env delete" -weight: 3 +weight: 4 --- ```bash diff --git a/site/content/en/docs/Commands/env/show.md b/site/content/en/docs/Commands/env/show.md new file mode 100644 index 00000000000..9c1020d2588 --- /dev/null +++ b/site/content/en/docs/Commands/env/show.md @@ -0,0 +1,27 @@ +--- +title: "env show" +linkTitle: "env show" +weight: 3 +--- + +```bash +$ copilot env show [flags] +``` + +### What does it do? +`copilot env ls` shows info about a deployed environment, including region, account ID, and services. + +### What are the flags? +```bash +-h, --help help for show + --json Optional. Outputs in JSON format. +-n, --name string Name of the environment. + --resources Optional. Show the resources in your environment. +``` +You can use the `--json` flag if you'd like to programmatically parse the results. + +### Examples +Shows info about the environment "test". +```bash +$ copilot env show -n test +``` From 450dd20ba1a645fcdd777eed0bf6f3031ab47389 Mon Sep 17 00:00:00 2001 From: git823 Date: Sat, 25 Jul 2020 13:02:18 +0900 Subject: [PATCH 2/3] docs: correct subcommand name for "What does it do?". current: `copilot env ls` shows info about a deployed environment, including region, account ID, and services. suggest: `copilot env show` shows info about a deployed environment, including region, account ID, and services. `copilot env ls` is another sub command. `copilot env show` is correct. --- site/content/en/docs/Commands/env/show.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/en/docs/Commands/env/show.md b/site/content/en/docs/Commands/env/show.md index 9c1020d2588..35b4f3bc464 100644 --- a/site/content/en/docs/Commands/env/show.md +++ b/site/content/en/docs/Commands/env/show.md @@ -9,7 +9,7 @@ $ copilot env show [flags] ``` ### What does it do? -`copilot env ls` shows info about a deployed environment, including region, account ID, and services. +`copilot env show` shows info about a deployed environment, including region, account ID, and services. ### What are the flags? ```bash From 6e9a8915a822be233134fe81096be1386c801e05 Mon Sep 17 00:00:00 2001 From: git823 Date: Sat, 25 Jul 2020 13:23:36 +0900 Subject: [PATCH 3/3] fix: weight of docs/Commands/env/_index.md. I changed weight of docs/Commands/env/_index.md incorrectly in previous commit. I reverted it. --- site/content/en/docs/Commands/env/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/en/docs/Commands/env/_index.md b/site/content/en/docs/Commands/env/_index.md index ac63a5ee36d..103fbd144b0 100644 --- a/site/content/en/docs/Commands/env/_index.md +++ b/site/content/en/docs/Commands/env/_index.md @@ -1,7 +1,7 @@ --- title: "env" linkTitle: "env" -weight: 4 +weight: 3 expand: true --- Commands for environments.