Skip to content

Commit dc99f81

Browse files
authored
Updating readme items and disambiguating localization (#1121)
1 parent 92ac0c7 commit dc99f81

File tree

6 files changed

+30
-25
lines changed

6 files changed

+30
-25
lines changed

extension-readme.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -196,25 +196,30 @@ 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 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. |
199+
| AWS Command | Description |
200+
| :----------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
201+
| **AWS: About AWS Toolkit** | Displays information about the AWS Toolkit. |
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 a New Issue on Github** | Opens the AWS Toolkit's [New Issue page on Github](https://github.com/aws/aws-toolkit-vscode/issues/new/choose). |
205+
| **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. |
206+
| **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. |
207+
| **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. |
208+
| **AWS: Detect SAM CLI** | Checks whether the Toolkit can communicate correctly with the AWS SAM CLI that is installed. |
209+
| **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. |
210+
| **AWS: Hide region from the Explorer** | Hides an AWS Region from the **AWS Explorer**. |
211+
| **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. |
212+
| **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. |
213+
| **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). |
214+
| **AWS: Show region in the Explorer** | Displays an AWS Region in the **AWS Explorer**. |
215+
| **AWS: Sign out** | Disconnects the Toolkit from the currently-connected AWS account. |
216+
| **AWS: Submit Quick Feedback...** | Submit a private, one-way message and sentiment to the AWS Toolkit dev team. For larger issues that warrant conversations or bugfixes, please submit an issue in Github with the **AWS: Create a New Issue on Github** command. |
217+
| **AWS: View AWS Toolkit Logs** | Displays log files that contain general Toolkit diagnostic information. |
218+
| **AWS: View Quick Start** | Open this quick-start guide. |
219+
| **AWS: View CDK Documentation** | Opens the [user guide](https://docs.aws.amazon.com/console/toolkit-for-vscode/aws-cdk-apps) for the CDK portion of the Toolkit. |
220+
| **AWS: View Toolkit Documentation** | Opens the [user guide](https://docs.aws.amazon.com/console/toolkit-for-vscode/welcome) for the Toolkit. |
221+
| **AWS: View Source on GitHub** | Opens the [GitHub repository](https://github.com/aws/aws-toolkit-vscode) for the Toolkit. |
222+
| **Explorer: Focus on AWS CDK Explorer (Preview) View** | Opens the **Explorer** Side Bar and expands the **AWS CDK Explorer (Preview)** View. |
218223

219224
{ [Return to Contents](#contents) } or { [Return to Top](#top) }
220225

package.nls.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@
8787
"AWS.telemetry.notificationOk": "OK",
8888
"AWS.telemetry.notificationViewSettings": "View Settings",
8989
"AWS.command.github": "View Source on GitHub",
90-
"AWS.command.help": "View Documentation",
90+
"AWS.command.help": "View Toolkit Documentation",
9191
"AWS.command.login": "Connect to AWS",
9292
"AWS.command.logout": "Sign out",
9393
"AWS.command.createIssueOnGitHub": "Create a New Issue on GitHub",
@@ -105,7 +105,7 @@
105105
"AWS.command.refreshAwsExplorer": "Refresh AWS Explorer",
106106
"AWS.command.refreshCdkExplorer": "Refresh CDK Explorer",
107107
"AWS.command.cdk.provideFeedback": "Provide Feedback",
108-
"AWS.command.cdk.help": "View Documentation",
108+
"AWS.command.cdk.help": "View CDK Documentation",
109109
"AWS.command.samcli.detect": "Detect SAM CLI",
110110
"AWS.command.deleteCloudFormation": "Delete CloudFormation Stack",
111111
"AWS.command.viewSchemaItem": "View Schema",

src/eventSchemas/wizards/schemaCodeDownloadWizard.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export interface SchemaCodeDownloadWizardContext {
4040

4141
export class DefaultSchemaCodeDownloadWizardContext extends WizardContext implements SchemaCodeDownloadWizardContext {
4242
public readonly schemaLangs = codeLang.schemaCodeLangs
43-
private readonly helpButton = createHelpButton(localize('AWS.command.help', 'View Documentation'))
43+
private readonly helpButton = createHelpButton(localize('AWS.command.help', 'View Toolkit Documentation'))
4444
public constructor(private readonly node: SchemaItemNode) {
4545
super()
4646
this.node = node

src/lambda/wizards/samDeployWizard.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ export class DefaultSamDeployWizardContext implements SamDeployWizardContext {
123123
public readonly onDetectLocalTemplates = detectLocalTemplates
124124
public readonly getParameters = getParameters
125125
public readonly getOverriddenParameters = getOverriddenParameters
126-
private readonly helpButton = createHelpButton(localize('AWS.command.help', 'View Documentation'))
126+
private readonly helpButton = createHelpButton(localize('AWS.command.help', 'View Toolkit Documentation'))
127127

128128
public constructor(private readonly regionProvider: RegionProvider, private readonly awsContext: AwsContext) {}
129129

src/lambda/wizards/samInitWizard.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export interface CreateNewSamAppWizardContext {
5656
export class DefaultCreateNewSamAppWizardContext extends WizardContext implements CreateNewSamAppWizardContext {
5757
// Filter out node8 until local debugging is no longer supported, and it can be removed from samLambdaRuntimes
5858
public readonly lambdaRuntimes = samLambdaRuntimes.filter(runtime => runtime !== 'nodejs8.10')
59-
private readonly helpButton = createHelpButton(localize('AWS.command.help', 'View Documentation'))
59+
private readonly helpButton = createHelpButton(localize('AWS.command.help', 'View Toolkit Documentation'))
6060
private readonly currentCredentials: Credentials | undefined
6161
private readonly schemasRegions: Region[]
6262
private readonly samCliVersion: string

src/stepFunctions/wizards/publishStateMachineWizard.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ interface PublishActionQuickPickItem {
6868
action: PublishStateMachineAction
6969
}
7070
export class DefaultPublishStateMachineWizardContext extends WizardContext implements PublishStateMachineWizardContext {
71-
private readonly helpButton = createHelpButton(localize('AWS.command.help', 'View Documentation'))
71+
private readonly helpButton = createHelpButton(localize('AWS.command.help', 'View Toolkit Documentation'))
7272
private iamRoles: IAM.roleListType | undefined
7373
private stateMachines: StepFunctions.StateMachineList | undefined
7474
private readonly iamClient: IamClient

0 commit comments

Comments
 (0)