Skip to content

Commit 5015af2

Browse files
alanboalanbo
authored
Update to extension readme (#992)
Authored-by: Alan Bogusiewicz <[email protected]>
1 parent ef74d3c commit 5015af2

File tree

3 files changed

+24
-21
lines changed

3 files changed

+24
-21
lines changed

‎extension-readme.md‎

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ These include the following:
5050

5151
- Amazon Elastic Container Service (Amazon ECS) task definition files
5252

53-
- Amazon Step Functions state machines
53+
- AWS Step Functions state machines
5454

5555
See [Features](#features) below for high-level details, or jump right into the [_AWS Toolkit for Visual Studio Code User Guide_](https://docs.aws.amazon.com/console/toolkit-for-vscode/welcome).
5656

@@ -86,7 +86,7 @@ For complete setup instructions for these three components, see [Installing the
8686
- [AWS CDK Applications](#cdk-apps)
8787
- [Amazon EventBridge Schemas](#eventbridge)
8888
- [Amazon ECS Task Definition Files](#ecs-files)
89-
- [Amazon Step Functions](#sfn-files)
89+
- [AWS Step Functions](#sfn-files)
9090

9191
{ [Return to Contents](#contents) } or { [Return to Top](#top) }
9292

@@ -174,17 +174,17 @@ For full details, see [Working with Amazon Elastic Container Service](https://do
174174

175175
---
176176

177-
## <a id="sfn-files"></a>Amazon Step Functions
177+
## <a id="sfn-files"></a>AWS Step Functions
178178

179-
The AWS Toolkit provides support for [Amazon Step Functions](https://docs.aws.amazon.com/step-functions). With the Toolkit installed in VS Code, working with state machines is a more streamlined process.
179+
The AWS Toolkit provides support for [AWS Step Functions](https://docs.aws.amazon.com/step-functions). With the Toolkit installed in VS Code, working with state machines is a more streamlined process.
180180

181181
- Create, update, execute, and download state machines.
182182
- See live graph visualizations of your state machine.
183183
- Take advantage of features such as code completion and validation, and code snippets.
184184

185185
Example:
186186

187-
![Amazon Step Functions](./resources/marketplace/sfn-state-machine.png)
187+
![AWS Step Functions](./resources/marketplace/sfn-state-machine.png)
188188

189189
For full details, see [Working with AWS Step Functions](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/stepfunctions.html) in the Toolkit's user guide.
190190

@@ -196,22 +196,25 @@ For full details, see [Working with AWS Step Functions](https://docs.aws.amazon.
196196

197197
The AWS Toolkit has several features that you can access through the [Command Palette](#open-command-palette) (select **View**, then **Command Palette**):
198198

199-
| AWS Command | Description |
200-
| :------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
201-
| **AWS: Create Credentials Profile** | Creates an AWS credentials profile. For more information, see [Setting Up Your AWS Credentials](https://docs.aws.amazon.com/console/toolkit-for-vscode/setup-credentials) in the user guide. |
202-
| **AWS: Connect to AWS** | Connects the Toolkit to an AWS account. For more information, see [Connecting to AWS](https://docs.aws.amazon.com/console/toolkit-for-vscode/connect) in the user guide. |
203-
| **AWS: Create New SAM Application** | Generates a set of code files for a new AWS serverless application. For more information, see [Creating a Serverless Application](https://docs.aws.amazon.com/console/toolkit-for-vscode/create-sam) in the user guide. |
204-
| **AWS: Deploy SAM Application** | Deploys a local serverless application to an AWS account. For more information, see [Deploying a Serverless Application](https://docs.aws.amazon.com/console/toolkit-for-vscode/deploy-serverless-app) in the user guide. |
205-
| **AWS: Detect SAM CLI** | Checks whether the Toolkit can communicate correctly with the AWS SAM CLI that is installed. |
206-
| **AWS: Focus on Explorer View** | Opens the **AWS: Explorer** Side Bar, which we will simply call [_the **AWS Explorer**_](#ui-components-aws-expl), and then moves the focus there. |
207-
| **AWS: Hide region from the Explorer** | Hides an AWS Region from the **AWS Explorer**. |
208-
| **AWS: Report an Issue** | In the [GitHub repository](https://github.com/aws/aws-toolkit-vscode) for the Toolkit, opens the page to [create a new issue](https://github.com/aws/aws-toolkit-vscode/issues/new/choose). |
209-
| **AWS: Show region in the Explorer** | Displays an AWS Region in the **AWS Explorer**. |
210-
| **AWS: Sign out** | Disconnects the Toolkit from the currently-connected AWS account. |
211-
| **AWS: View AWS Toolkit Logs** | Displays log files that contain general Toolkit diagnostic information. |
212-
| **AWS: View Quick Start** | Open this quick-start guide. |
213-
| **AWS: View Documentation** | Opens the [user guide](https://docs.aws.amazon.com/console/toolkit-for-vscode/welcome) for the Toolkit. |
214-
| **AWS: View Source on GitHub** | Opens the [GitHub repository](https://github.com/aws/aws-toolkit-vscode) for the Toolkit. |
199+
| AWS Command | Description |
200+
| :------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
201+
| **AWS: Create Credentials Profile** | Creates an AWS credentials profile. For more information, see [Setting Up Your AWS Credentials](https://docs.aws.amazon.com/console/toolkit-for-vscode/setup-credentials) in the user guide. |
202+
| **AWS: Connect to AWS** | Connects the Toolkit to an AWS account. For more information, see [Connecting to AWS](https://docs.aws.amazon.com/console/toolkit-for-vscode/connect) in the user guide. |
203+
| **AWS: Create a new Step Functions state machine** | Generates a new Amazon States Language definition to use as the definition for a new Step Functions state machine. For more information, see [State Machine Templates](https://docs.aws.amazon.com//toolkit-for-vscode/latest/userguide/bulding-stepfunctions.html#templates-stepfunctions) in the user guide. |
204+
| **AWS: Create New SAM Application** | Generates a set of code files for a new AWS serverless application. For more information, see [Creating a Serverless Application](https://docs.aws.amazon.com/console/toolkit-for-vscode/create-sam) in the user guide. |
205+
| **AWS: Deploy SAM Application** | Deploys a local serverless application to an AWS account. For more information, see [Deploying a Serverless Application](https://docs.aws.amazon.com/console/toolkit-for-vscode/deploy-serverless-app) in the user guide. |
206+
| **AWS: Detect SAM CLI** | Checks whether the Toolkit can communicate correctly with the AWS SAM CLI that is installed. |
207+
| **AWS: Focus on Explorer View** | Opens the **AWS: Explorer** Side Bar, which we will simply call [_the **AWS Explorer**_](#ui-components-aws-expl), and then moves the focus there. |
208+
| **AWS: Hide region from the Explorer** | Hides an AWS Region from the **AWS Explorer**. |
209+
| **AWS: Publish state machine to Step Functions** | Creates or updates a remote state machine using the local Amazon States Language definition file. For more information, see [Work With State Machines in VS Code](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/bulding-stepfunctions.html#starting-stepfunctions) in the user guide. |
210+
| **AWS: Render state machine graph** | Renders the state machine definition into a graph visualization. For more information, see [State Machine Graph Visualization](https://docs.aws.amazon.com//toolkit-for-vscode/latest/userguide/bulding-stepfunctions.html#bulding-stepfunctions-visualizations) in the user guide. |
211+
| **AWS: Report an Issue** | In the [GitHub repository](https://github.com/aws/aws-toolkit-vscode) for the Toolkit, opens the page to [create a new issue](https://github.com/aws/aws-toolkit-vscode/issues/new/choose). |
212+
| **AWS: Show region in the Explorer** | Displays an AWS Region in the **AWS Explorer**. |
213+
| **AWS: Sign out** | Disconnects the Toolkit from the currently-connected AWS account. |
214+
| **AWS: View AWS Toolkit Logs** | Displays log files that contain general Toolkit diagnostic information. |
215+
| **AWS: View Quick Start** | Open this quick-start guide. |
216+
| **AWS: View Documentation** | Opens the [user guide](https://docs.aws.amazon.com/console/toolkit-for-vscode/welcome) for the Toolkit. |
217+
| **AWS: View Source on GitHub** | Opens the [GitHub repository](https://github.com/aws/aws-toolkit-vscode) for the Toolkit. |
215218

216219
{ [Return to Contents](#contents) } or { [Return to Top](#top) }
217220

‎resources/marketplace/overview.png‎

13.7 KB
Loading

‎resources/marketplace/sfn-state-machine.png‎

99.3 KB
Loading

0 commit comments

Comments
 (0)