Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 25a2c4d

Browse files
tjholmjyecusch
andauthored
Apply suggestions from code review
Co-authored-by: Jye Cusch <[email protected]>
1 parent 6e831e5 commit 25a2c4d

File tree

3 files changed

+27
-23
lines changed

3 files changed

+27
-23
lines changed

docs/providers/pulumi/aws/index.mdx

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,23 +55,25 @@ You can create an Access Key by logging into the [AWS console](https://aws.amazo
5555
for full details on credentials and configuration.
5656
</Note>
5757

58-
## Locating resources deployed with Nitric
58+
## Locating deployed resources
5959

60-
Nitric creates a resource tag manager group and tags all possible resources to be referenced by this group. You can locate resources in the console by going to the [AWS Console](https://console.aws.amazon.com/)
60+
This Nitric AWS provider creates a resource tag manager group and tags all possible resources to be referenced by this group. You can locate resources using the [AWS Console](https://console.aws.amazon.com/).
6161

62-
Navigate to the resource groups service:
62+
Start by navigating to the [Resource Groups service](https://console.aws.amazon.com/resource-groups/home):
6363

6464
![resource group search image](/docs/images/docs/aws-rg.png)
6565

66-
Find your resource group in the resource groups list and click it:
66+
Find your stack's resource group in the list and click it:
6767

68-
![resource group list image](/docs/images/docs/aws-rg-screen.png)
68+
<Note>
69+
Resource groups are conventionally named `<project-name>-<stack-name>`
6970

70-
Resource groups are conventionally named `<project-name>-<stack-name>`
71+
In this example the project name is `api-testing` and the stack name is `aws`.
72+
</Note>
7173

72-
So in the example above, the project name is `api-testing` and the stack name is `aws`.
74+
![resource group list image](/docs/images/docs/aws-rg-screen.png)
7375

74-
More recent versions of the Nitric AWS provider also output a direct link to it's resource group in the console from running `nitric up`
76+
More recent versions of the Nitric AWS provider also display a direct link to the resource group in output from `nitric up`.
7577

7678
Example:
7779

docs/providers/pulumi/azure/index.mdx

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -75,20 +75,21 @@ brew update && brew install azure-cli
7575

7676
</OSTabs>
7777

78-
## Locating resources deployed with Nitric
78+
## Locating deployed resources
7979

80-
Nitric deploys all Azure resources for a stack into a resource group dedicated to that stack. You can either use one your already have by configuring it in the stack configuration or let Nitric create one for you.
80+
This Nitric Azure provider deploys resources for a stack into a resource group dedicated to that stack. You can either use one your already have by configuring it in the stack configuration or let Nitric create one for you.
8181

82-
Once a nitric stack is deployed to azure it's resource group should be present in the [Resource groups](https://portal.azure.com/#blade/HubsExtension/BrowseResourceGroupBlade/resourceType/Microsoft.Resources%2Fsubscriptions%2FresourceGroups) page of your portal. Assuming it was deployed to a subscription you have access to.
82+
Once a stack has been deployed to Azure it's resource group should be present in the [Resource groups](https://portal.azure.com/#blade/HubsExtension/BrowseResourceGroupBlade/resourceType/Microsoft.Resources%2Fsubscriptions%2FresourceGroups) page of the portal. Assuming it was deployed to a subscription you have access to.
8383

84-
Resource groups are named conventionally `<project-name>-<stack-name>-<randomId>`
84+
<Note>
85+
Resource groups are conventionally named `<project-name>-<stack-name>-<randomId>`
8586

86-
For example:
87-
![resource group page screen](/docs/images/docs/az-rg.png)
87+
In this example the project name is `api-testing` and the stack name is `az`.
88+
</Note>
8889

89-
So in the example above, the project name is `api-testing` and the stack name is `az`.
90+
![resource group page screen](/docs/images/docs/az-rg.png)
9091

91-
More recent versions of the Nitric Azure provider also output a direct link to it's resource group in the console from running `nitric up`
92+
More recent versions of the Nitric Azure provider display a direct link to the resource group in output from `nitric up`.
9293

9394
Example:
9495

docs/providers/terraform/aws.mdx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,22 +70,23 @@ You can create an Access Key by logging into the [AWS console](https://aws.amazo
7070
for full details on credentials and configuration.
7171
</Note>
7272

73-
## Locating resources deployed with Nitric
73+
## Locating deployed resources
7474

7575
Nitric creates a resource tag manager group and tags all possible resources to be referenced by this group. You can locate resources in the console by going to the [AWS Console](https://console.aws.amazon.com/)
7676

77-
Navigate to the resource groups service:
77+
Next, navigate to the [Resource Groups service](https://console.aws.amazon.com/resource-groups/home):
7878

7979
![resource group search image](/docs/images/docs/aws-rg.png)
8080

81-
Find your resource group in the resource groups list and click it:
81+
Find your stack's resource group in the list and click it:
8282

83-
![resource group list image](/docs/images/docs/aws-rg-screen.png)
84-
85-
Resource groups are conventionally named `<project-name>-<stack-name>`
83+
<Note>
84+
Resource groups are conventionally named `<project-name>-<stack-name>`
8685

87-
So in the example above, the project name is `api-testing` and the stack name is `aws`.
86+
In this example the project name is `api-testing` and the stack name is `aws`.
87+
</Note>
8888

89+
![resource group list image](/docs/images/docs/aws-rg-screen.png)
8990
## Stack Configuration
9091

9192
```yaml title:nitric.[stack ID].yaml

0 commit comments

Comments
 (0)