Skip to content

Commit 10a54e9

Browse files
committed
fix: Addressing easy to address PR feedback
1 parent 6d0cb39 commit 10a54e9

File tree

2 files changed

+36
-12
lines changed

2 files changed

+36
-12
lines changed

docs/2.0/docs/pipelines/installation/addingexistinggitlabrepo.mdx

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Review your existing project structure and identify:
6565

6666
For each AWS Account / Azure Subscription you want to manage, you might already have some or all of the following resources provisioned.
6767

68-
<Tabs>
68+
<Tabs groupId="cloud-provider">
6969
<TabItem value="aws" label="AWS" default>
7070

7171
**Required AWS Resources:**
@@ -96,9 +96,9 @@ For each AWS Account / Azure Subscription you want to manage, you might already
9696

9797
## Configuring SCM Access
9898

99-
Pipelines needs the ability to interact with Source Control Management (SCM) platforms to fetch resources (e.g. IaC code, reusable CI/CD code and the Pipelines binary itself).
99+
Pipelines needs the ability to interact with GitLab to fetch resources (e.g. IaC code, reusable CI/CD code and the Pipelines binary itself).
100100

101-
For GitLab, you'll need to configure SCM access using [machine users](/2.0/docs/pipelines/installation/viamachineusers) with appropriate Personal Access Tokens (PATs).
101+
To create machine users for GitLab access, follow our [machine users guide](/2.0/docs/pipelines/installation/viamachineusers) to set up the appropriate Personal Access Tokens (PATs) with the required permissions.
102102

103103
:::note Progress Checklist
104104

@@ -186,7 +186,7 @@ mise use -g terragrunt@latest opentofu@latest
186186

187187
### Cloud-specific bootstrap instructions
188188

189-
<Tabs>
189+
<Tabs groupId="cloud-provider">
190190
<TabItem value="aws" label="AWS" default>
191191

192192
The resources you need provisioned in AWS to start managing resources with Pipelines are:
@@ -253,7 +253,7 @@ EOF
253253

254254
If you don't have a `root.hcl` file, you might need to customize the bootstrapping process, as the Terragrunt scale catalog expects a `root.hcl` file in the root of the project. Please contact [Gruntwork support](/support) for assistance if you need help.
255255

256-
For each AWS account that needs bootstrapping, we'll use Boilerplate to scaffold the necessary content.
256+
For each AWS account that needs bootstrapping, we'll use Boilerplate to scaffold the necessary content. Run this command from the root of your project for each account:
257257

258258
```bash
259259
boilerplate \
@@ -263,6 +263,12 @@ boilerplate \
263263

264264
:::tip
265265

266+
You'll need to run this boilerplate command once for each AWS account you want to manage with Pipelines. Boilerplate will prompt you for account-specific values each time.
267+
268+
:::
269+
270+
:::tip
271+
266272
You can reply `y` to all the prompts to include dependencies, and accept defaults unless you want to customize something.
267273

268274
Alternatively, you could run Boilerplate non-interactively by passing the `--non-interactive` flag. You'll need to supply the relevant values for required variables in that case.
@@ -405,7 +411,7 @@ The process that we'll follow to get these resources ready for Pipelines is:
405411
{/* We're using an h3 tag here instead of a markdown heading to avoid adding content to the ToC that won't work when switching between tabs */}
406412
<h3>Bootstrap Your Project for Azure</h3>
407413

408-
For each Azure subscription that needs bootstrapping, we'll use Boilerplate to scaffold the necessary content.
414+
For each Azure subscription that needs bootstrapping, we'll use Boilerplate to scaffold the necessary content. Run this command from the root of your project for each subscription:
409415

410416
```bash
411417
boilerplate \
@@ -415,6 +421,12 @@ boilerplate \
415421

416422
:::tip
417423

424+
You'll need to run this boilerplate command once for each Azure subscription you want to manage with Pipelines. Boilerplate will prompt you for subscription-specific values each time.
425+
426+
:::
427+
428+
:::tip
429+
418430
You can reply `y` to all the prompts to include dependencies, and accept defaults unless you want to customize something.
419431

420432
Alternatively, you could run Boilerplate non-interactively by passing the `--non-interactive` flag. You'll need to supply the relevant values for required variables in that case.
@@ -676,7 +688,7 @@ Next, you'll want to define the environments you want to manage with Pipelines u
676688

677689
For each environment, you'll want to define a [`filter` block](/2.0/reference/pipelines/configurations-as-code/api#filter-block) that tells Pipelines which units are part of that environment. You'll also want to define an [`authentication` block](/2.0/reference/pipelines/configurations-as-code/api#authentication-block) that tells Pipelines how to authenticate with your cloud provider(s) for that environment.
678690

679-
<Tabs>
691+
<Tabs groupId="cloud-provider">
680692
<TabItem value="aws" label="AWS" default>
681693

682694
```hcl title=".gruntwork/environment-production.hcl"

docs/2.0/docs/pipelines/installation/addingexistingrepo.mdx

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Review your existing repository structure and identify:
5050

5151
For each AWS Account / Azure Subscription you want to manage, you might already have some or all of the following resources provisioned.
5252

53-
<Tabs>
53+
<Tabs groupId="cloud-provider">
5454
<TabItem value="aws" label="AWS" default>
5555

5656
**Required AWS Resources:**
@@ -174,7 +174,7 @@ mise use -g terragrunt@latest opentofu@latest
174174

175175
### Cloud-specific bootstrap instructions
176176

177-
<Tabs>
177+
<Tabs groupId="cloud-provider">
178178
<TabItem value="aws" label="AWS" default>
179179

180180
The resources you need provisioned in AWS to start managing resources with Pipelines are:
@@ -241,7 +241,7 @@ EOF
241241

242242
If you don't have a `root.hcl` file, you might need to customize the bootstrapping process, as the Terragrunt scale catalog expects a `root.hcl` file in the root of the repository. Please contact [Gruntwork support](/support) for assistance if you need help.
243243

244-
For each AWS account that needs bootstrapping, we'll use Boilerplate to scaffold the necessary content.
244+
For each AWS account that needs bootstrapping, we'll use Boilerplate to scaffold the necessary content. Run this command from the root of your repository for each account:
245245

246246
```bash
247247
boilerplate \
@@ -251,6 +251,12 @@ boilerplate \
251251

252252
:::tip
253253

254+
You'll need to run this boilerplate command once for each AWS account you want to manage with Pipelines. Boilerplate will prompt you for account-specific values each time.
255+
256+
:::
257+
258+
:::tip
259+
254260
You can reply `y` to all the prompts to include dependencies, and accept defaults unless you want to customize something.
255261

256262
Alternatively, you could run Boilerplate non-interactively by passing the `--non-interactive` flag. You'll need to supply the relevant values for required variables in that case.
@@ -374,7 +380,7 @@ The process that we'll follow to get these resources ready for Pipelines is:
374380
{/* We're using an h3 tag here instead of a markdown heading to avoid adding content to the ToC that won't work when switching between tabs */}
375381
<h3>Bootstrap Your Repository for Azure</h3>
376382

377-
For each Azure subscription that needs bootstrapping, we'll use Boilerplate to scaffold the necessary content.
383+
For each Azure subscription that needs bootstrapping, we'll use Boilerplate to scaffold the necessary content. Run this command from the root of your repository for each subscription:
378384

379385
```bash
380386
boilerplate \
@@ -384,6 +390,12 @@ boilerplate \
384390

385391
:::tip
386392

393+
You'll need to run this boilerplate command once for each Azure subscription you want to manage with Pipelines. Boilerplate will prompt you for subscription-specific values each time.
394+
395+
:::
396+
397+
:::tip
398+
387399
You can reply `y` to all the prompts to include dependencies, and accept defaults unless you want to customize something.
388400

389401
Alternatively, you could run Boilerplate non-interactively by passing the `--non-interactive` flag. You'll need to supply the relevant values for required variables in that case.
@@ -643,7 +655,7 @@ Next, you'll want to define the environments you want to manage with Pipelines u
643655

644656
For each environment, you'll want to define a [`filter` block](/2.0/reference/pipelines/configurations-as-code/api#filter-block) that tells Pipelines which units are part of that environment. You'll also want to define an [`authentication` block](/2.0/reference/pipelines/configurations-as-code/api#authentication-block) that tells Pipelines how to authenticate with your cloud provider(s) for that environment.
645657

646-
<Tabs>
658+
<Tabs groupId="cloud-provider">
647659
<TabItem value="aws" label="AWS" default>
648660

649661
```hcl title=".gruntwork/environment-production.hcl"

0 commit comments

Comments
 (0)