Skip to content

Commit 52978f8

Browse files
committed
update for AEM-supported xrefs
1 parent 056d5c0 commit 52978f8

10 files changed

+49
-49
lines changed

docs/how-to-guides/_getting-started.html.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ and to current and future teammates and collaborators.</p>
293293

294294
#### <a></a> The test task
295295

296-
Platform Automation Toolkit comes with a [`test`](../tasks.md#test) task you
296+
Platform Automation Toolkit comes with a [`test`](../tasks.html#test) task you
297297
can use to validate that it's been installed correctly.
298298

299299
1. Add the following to your `pipeline.yml`, starting on the line after the `---`:

docs/how-to-guides/adding-a-product.html.md.erb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The instructions and example in the following add the [VMware Tanzu Application
3939

4040
### Download
4141

42-
Before setting the pipeline, create a config file for [`download-product`](../tasks.md#download-product)
42+
Before setting the pipeline, create a config file for [`download-product`](../tasks.html#download-product)
4343
to download Tanzu Application Service from the Broadcom Support portal.
4444

4545
Create a `download-tas.yml` file for the IaaS you are using.
@@ -113,7 +113,7 @@ you can add a new `download-upload-and-stage-tas` job in your `pipeline.yml` fil
113113
4. If fly set-pipeline returns an error,
114114
fix any and all errors until the pipeline can be set.
115115
When the pipeline can be set properly, run:
116-
116+
117117
```
118118
git add pipeline.yml
119119
git commit --amend --no-edit
@@ -228,7 +228,7 @@ You can still go through this process without an initial applying changes,
228228
but you will be unable to use <code>om staged-config</code> with <code>--include-credentials</code>,
229229
and may have an incomplete configuration at the end of this process.</p>
230230

231-
[`om`](https://github.com/pivotal-cf/om) has a command called [staged-config](../tasks.md#staged-config).
231+
[`om`](https://github.com/pivotal-cf/om) has a command called [staged-config](../tasks.html#staged-config).
232232
It is used to extract staged product
233233
configuration from the Tanzu Operations Manager UI.
234234
`om` requires a `env.yml`, which is available. It was used in the `upload-and-stage` task.
@@ -628,7 +628,7 @@ outlined in these examples is `config-template`.
628628
`config-template` is an `om` command that creates a base config file with optional ops files
629629
from a given tile or pivnet slug.
630630

631-
This section assumes that you are adding
631+
This section assumes that you are adding
632632
[TAS for VMs](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20Application%20Service%20for%20VMs),
633633
as in the procedure above.
634634

@@ -700,7 +700,7 @@ here are some approaches you can use:
700700
- Look at the tile's online documentation
701701
- Upload the tile to a Tanzu Operations Manager
702702
and visit the tile in the Tanzu Operations Manager UI to see if that provides any hints.
703-
703+
704704
If you are still struggling, inspect the HTML of the Tanzu Operations Manager web page
705705
to help you map the value names to the associated UI elements.
706706

docs/how-to-guides/creating-a-director-config-file.html.md.erb

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ For detailed instructions, see [Installing Tanzu Operations Manager](./installin
1414

1515
## Extracting configuration
1616

17-
In [om](https://github.com/pivotal-cf/om) there is a command called [staged-director-config](../tasks.md#staged-director-config), which is used to extract
17+
In [om](https://github.com/pivotal-cf/om) there is a command called [staged-director-config](../tasks.html#staged-director-config), which is used to extract
1818
the Tanzu Operations Manager and the BOSH director configuration from the targeted foundation.
1919

2020
<%= partial "../missing_fields_opsman_director" %>
2121

22-
Sample usage:
23-
`om --env env.yml staged-director-config > director.yml`
22+
Sample usage:
23+
`om --env env.yml staged-director-config > director.yml`
2424

2525
This gives you the whole configuration of Tanzu Operations Manager in a single YAML file.
2626
It will look more or less the same as the example above. You can check it
@@ -36,10 +36,10 @@ after running this command:
3636
Now you can modify the settings in the configuration file directly instead of
3737
operating in the Web UI. After you finish editing the file, the configuration
3838
file will need to be applied back to the Tanzu Operations Manager instance. The command
39-
[configure-director](../tasks.md#configure-director) will do the job.
39+
[configure-director](../tasks.html#configure-director) will do the job.
4040

41-
Sample usage:
42-
`om --env env.yml configure-director --config director.yml`
41+
Sample usage:
42+
`om --env env.yml configure-director --config director.yml`
4343

4444

4545
## Promoting Tanzu Operations Manager to another foundation
@@ -67,7 +67,7 @@ and they change the default behavior if they are defined.
6767
Use with caution.
6868

6969
In the following example, two new VM extensions are defined
70-
and will be added to the list of available extensions on the next [`configure-director`](../tasks.md#configure-director).
70+
and will be added to the list of available extensions on the next [`configure-director`](../tasks.html#configure-director).
7171
This can be added to the end of your existing `director.yml`,
7272
or defined independently and set with no other configurations present.
7373

@@ -111,7 +111,7 @@ and they change the default behavior if they are defined.
111111
Use with caution.
112112

113113
In the following example, two new VM types are defined
114-
and will be added to the list of available types on the next [`configure-director`](../tasks.md#configure-director).
114+
and will be added to the list of available types on the next [`configure-director`](../tasks.html#configure-director).
115115
This can be added to the end of your existing `director.yml`,
116116
or defined independently and set with no other configurations present.
117117

docs/how-to-guides/git-repo-layout.html.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ There are many possibilities for structuring Git repos in complex situations.
163163
For guidance on how to best set up your git's file structure,
164164
see [Inputs and outputs](../inputs-outputs.md).
165165
Take note of the `inputs` and `outputs` of the
166-
various [Platform Automation Toolkit tasks](../tasks.md).
166+
various [Platform Automation Toolkit tasks](../tasks.html).
167167
As long as the various input / output mappings correctly correlate
168168
to the expected inputs and outputs of the Platform Automation Toolkit tasks,
169169
any file structure could theoretically work.

docs/how-to-guides/installing-opsman.html.md.erb

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Do this by changing:
1515
- the `name` of the task
1616
- the `file` of the task
1717

18-
The first task in the job should be [`download-product`](../tasks.md#download-product).
18+
The first task in the job should be [`download-product`](../tasks.html#download-product).
1919
It has an additional required input;
2020
the `config` file `download-product` uses to talk to the Broadcom Support portal.
2121

@@ -141,7 +141,7 @@ for creating a deploy key.
141141
<%= partial include './paths-and-pipeline-names' %>
142142

143143
1. To perform interpolation in one of your input files,
144-
use the [`prepare-tasks-with-secrets` task](../tasks.md#prepare-tasks-with-secrets).
144+
use the [`prepare-tasks-with-secrets` task](../tasks.html#prepare-tasks-with-secrets).
145145
In earlier steps, you relied on Concourse's native integration with CredHub for interpolation.
146146
That worked because you needed to use the variable
147147
in the pipeline itself, not in one of our inputs.
@@ -175,7 +175,7 @@ in the pipeline itself, not in one of our inputs.
175175
tasks: platform-automation-tasks
176176
params:
177177
CONFIG_PATHS: config
178-
- task: download-product
178+
- task: download-product
179179
image: platform-automation-image
180180
file: platform-automation-tasks/tasks/download-product.yml
181181
params:
@@ -248,7 +248,7 @@ Follow these steps to use the `paving` repository:
248248
# cp -Ra paving/${IAAS} paving-${IAAS}
249249
mkdir paving-${IAAS}
250250
cp -a paving/$IAAS/. paving-$IAAS
251-
cd paving-${IAAS}
251+
cd paving-${IAAS}
252252
```
253253

254254
`IAAS` must be set to match one of the infrastructure directories
@@ -288,7 +288,7 @@ Follow these steps to use the `paving` repository:
288288
```bash
289289
terraform apply \
290290
-parallelism=5 \
291-
terraform.tfplan
291+
terraform.tfplan
292292
```
293293

294294
8. Save the output from `terraform output stable_config`
@@ -364,7 +364,7 @@ you can add the new task to the `install-opsman` job.
364364
tasks: platform-automation-tasks
365365
params:
366366
CONFIG_PATHS: config
367-
- task: download-product
367+
- task: download-product
368368
image: platform-automation-image
369369
file: platform-automation-tasks/tasks/download-product.yml
370370
params:
@@ -526,7 +526,7 @@ and the placeholder state file.
526526
tasks: platform-automation-tasks
527527
params:
528528
CONFIG_PATHS: config
529-
- task: download-product
529+
- task: download-product
530530
image: platform-automation-image
531531
file: platform-automation-tasks/tasks/download-product.yml
532532
params:
@@ -549,7 +549,7 @@ and the placeholder state file.
549549
Because <code>opsman.yml</code> is the default input to
550550
<code>OPSMAN_CONFIG_FILE</code>, it is redundant
551551
to set this param in the pipeline.
552-
See the <a href="../tasks.md">Task reference</a>
552+
See the <a href="../tasks.html">Task reference</a>
553553
available and default parameters.</p>
554554

555555
1. Now set the pipeline.
@@ -583,7 +583,7 @@ and the placeholder state file.
583583
tasks: platform-automation-tasks
584584
params:
585585
CONFIG_PATHS: config
586-
- task: download-product
586+
- task: download-product
587587
image: platform-automation-image
588588
file: platform-automation-tasks/tasks/download-product.yml
589589
params:

docs/how-to-guides/setting-up-s3.html.md.erb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ You should probably **_not_** store the following in S3:
208208
- `secrets.yaml` environment and secret files - There are a number of ways
209209
to handle these types of files, but they should not be stored in S3.
210210
See [Using a secrets store to store credentials](../concepts/secrets-handling.md)
211-
for information about working with these types of files.
211+
for information about working with these types of files.
212212

213213
## Structuring your bucket
214214

@@ -238,7 +238,7 @@ The following sample shows one way to set up your bucket file structure:
238238

239239
When viewing a bucket in the AWS S3 console,
240240
click **Create Folder**.
241-
To create a sub-folder, select **Create Folder** again.
241+
To create a sub-folder, select **Create Folder** again.
242242

243243
When attempting to access a specific object in a folder,
244244
include the folder structure before the object name:
@@ -274,7 +274,7 @@ and where to find more information.
274274

275275
#### The download-product task
276276

277-
The [`download-product`](../tasks.md#download-product) task lets you download products from the Broadcom Support portal.
277+
The [`download-product`](../tasks.html#download-product) task lets you download products from the Broadcom Support portal.
278278
If S3 properties are set in the [download config](../inputs-outputs.md#download-product-config),
279279
these files can be put into an S3 bucket.
280280

@@ -320,7 +320,7 @@ For example, for a product with slug of <code>product-slug</code> and version of
320320
</code>
321321
</p>
322322

323-
The [`download-product`](../tasks.md#download-product)
323+
The [`download-product`](../tasks.html#download-product)
324324
task lets you download products from an blobstore bucket if you define the `SOURCE` param.
325325
The prefixed metadata added by `download-product` with `SOURCE: pivnet` is used to find the appropriate file.
326326
This task uses the same [download-product config file](../inputs-outputs.md#download-product-config)
@@ -333,4 +333,4 @@ to be used together.
333333
The download product config should be different between the two tasks.
334334

335335
For complete information on this task
336-
and how it works, see the [Task Reference](../tasks.md#download-product).
336+
and how it works, see the [Task Reference](../tasks.html#download-product).

docs/how-to-guides/upgrade-existing-opsman.html.md.erb

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Do this by changing:
3030
- the `name` of the task
3131
- the `file` of the task
3232

33-
The first task in the job should be [`download-product`](../tasks.md#download-product).
33+
The first task in the job should be [`download-product`](../tasks.html#download-product).
3434
It has an additional required input;
3535
the `config` file `download-product` uses to talk to the Broadcom Support portal.
3636

@@ -179,7 +179,7 @@ you can add a resource to tell Concourse how to get it as `env`.
179179
<%= partial "./paths-and-pipeline-names" %>
180180

181181
1. To perform interpolation in one of your input files,
182-
you need the [`credhub-interpolate` task](../tasks.md#credhub-interpolate)
182+
you need the [`credhub-interpolate` task](../tasks.html#credhub-interpolate)
183183
Earlier, you relied on Concourse's native integration with CredHub for interpolation.
184184
That worked because you needed to use the variable
185185
in the pipeline itself, not in one of your inputs.
@@ -337,7 +337,7 @@ it's time to create another Concourse job to do the upgrade itself.
337337
The export and the upgrade need to be in separate jobs
338338
so they can be triggered (and re-run) independently.
339339

340-
This new job uses the [`upgrade-opsman`](../tasks.md#upgrade-opsman) task.
340+
This new job uses the [`upgrade-opsman`](../tasks.html#upgrade-opsman) task.
341341

342342
1. Write a new job that has `get` steps
343343
for your platform-automation resources
@@ -393,7 +393,7 @@ it's a good place to start.
393393
This workflow makes it easy to keep what is set on Concourse
394394
and what is pushed to your source control remote in sync.</p>
395395

396-
1. You need the three required inputs for [`upgrade-opsman`](..//tasks.md#upgrade-opsman).
396+
1. You need the three required inputs for [`upgrade-opsman`](../tasks.html#upgrade-opsman).
397397

398398
* `state`
399399
* `config`
@@ -438,12 +438,12 @@ commit it, and push it:
438438
git push
439439
```
440440

441-
You can map the `env` resource to the [`upgrade-opsman`](..//tasks.md#upgrade-opsman)
441+
You can map the `env` resource to the [`upgrade-opsman`](../tasks.html#upgrade-opsman)
442442
`state` input after you add the task.
443443

444444
But first, there are two more inputs to arrange for.
445445

446-
1. Option 1: Write a [Tanzu Operations Manager VM Configuration file](../inputs-outputs.md#opsman-config)
446+
1. Option 1: Write a [Tanzu Operations Manager VM Configuration file](../inputs-outputs.html#opsman-config)
447447
to `opsman.yml`.
448448
The properties available vary by IaaS,
449449
but you can often inspect your existing Tanzu Operations Manager
@@ -749,7 +749,7 @@ in the directory it is called from.
749749
git push
750750
```
751751

752-
2. Get the image for the new Tanzu Operations Manager version using the [`download-product`](../tasks.md#download-product) task.
752+
2. Get the image for the new Tanzu Operations Manager version using the [`download-product`](../tasks.html#download-product) task.
753753
It requires a config file to specify which Tanzu Operations Manager to get,
754754
and to provide the Broadcom Support portal credentials.
755755
Name this file `download-opsman.yml`:
@@ -823,7 +823,7 @@ Name this file `download-opsman.yml`:
823823
<code>env.yml</code> is the default input to <code>ENV_FILE</code>,
824824
and <code>state.yml</code> is the default input to <code>STATE_FILE</code>,
825825
it is redundant to set this param in the pipeline.
826-
See the <a href="../tasks.md">task definitions</a>
826+
See the <a href="../tasks.html">task definitions</a>
827827
for a full range of the
828828
available and default parameters.</p>
829829

docs/pipeline-design/configuration-management-strategies.html.md.erb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ uses the "Single Repository for each Foundation" pattern:
4747
Notice that there is only one subdirectory
4848
and that all other files are in the base directory.
4949
This minimizes parameter mapping in the platform-automation tasks.
50-
For example, in the [`configure-director`](../tasks.md#configure-director)
50+
For example, in the [`configure-director`](../tasks.html#configure-director)
5151
step:
5252

5353
```yaml
@@ -110,7 +110,7 @@ The design considerations for this strategy, as implemented, are:
110110
It makes use of only concepts and workflows
111111
built in to Platform Automation and Concourse.
112112
- There are no significant differences between the required setup of the foundations.
113-
113+
114114
This doesn't mean that this strategy cannot be used
115115
with more complicated differences.
116116
If the pipelines need to be different for one reason or another,
@@ -353,9 +353,9 @@ This feature is only available in Concourse 5+. The example that follows does no
353353
In certain circumstances, resources can be modified by one task in a job
354354
for use later in that same job. A few tasks that offer this ability include:
355355

356-
- [credhub-interpolate](../tasks.md#credhub-interpolate)
357-
- [prepare-tasks-with-secrets](../tasks.md#prepare-tasks-with-secrets)
358-
- [prepare-image](../tasks.md#prepare-image)
356+
- [credhub-interpolate](../tasks.html#credhub-interpolate)
357+
- [prepare-tasks-with-secrets](../tasks.html#prepare-tasks-with-secrets)
358+
- [prepare-image](../tasks.html#prepare-image)
359359

360360
For each of these tasks, `output_mapping` can be used to overwrite
361361
an input with a modified input for use with tasks later in that job.

docs/pipelines/multiple-products.html.md.erb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ Platform Automation Toolkit will not create these resources for you.
186186
This secrets handling example helps load secrets stored in an external credential manager such as CredHub.
187187
Concourse support several [credential managers](https://concourse-ci.org/creds.html) natively.
188188

189-
The configuration below uses the [`prepare-tasks-with-secrets`](../tasks.md#prepare-tasks-with-secrets) task
189+
The configuration below uses the [`prepare-tasks-with-secrets`](../tasks.html#prepare-tasks-with-secrets) task
190190
to load secrets from your external configuration files.
191191

192192
```yaml
@@ -319,7 +319,7 @@ jobs:
319319
VARS_FILES: |
320320
vars/foundations/((foundation))/vars/director.yml
321321
vars/foundations/((foundation))/vars/tas.yml
322-
vars/foundations/((foundation))/vars/pks.yml
322+
vars/foundations/((foundation))/vars/pks.yml
323323
- task: apply-director-changes
324324
image: platform-automation-image
325325
attempts: 3
@@ -439,7 +439,7 @@ jobs:
439439
VARS_FILES: |
440440
vars/foundations/((foundation))/vars/director.yml
441441
vars/foundations/((foundation))/vars/tas.yml
442-
vars/foundations/((foundation))/vars/pks.yml
442+
vars/foundations/((foundation))/vars/pks.yml
443443
- task: apply-director-changes
444444
image: platform-automation-image
445445
file: platform-automation-tasks/tasks/apply-director-changes.yml

docs/pipelines/resources.html.md.erb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ and places them into a trusted s3-like storage provider.
2525
This helps other Concourse deployments without internet access
2626
retrieve task dependencies.
2727

28-
The pipeline requires configuration for the [download-product](../tasks.md#download-product) task.
28+
The pipeline requires configuration for the [download-product](../tasks.html#download-product) task.
2929
See the following for examples that you can use.
3030

3131
<p class="note important">
@@ -37,7 +37,7 @@ to accurately download files from a blobstore (for example, s3, gcs, azure),
3737
so the product slug and version are prepended when using <code>download-product</code>.
3838
For more information about how this works,
3939
and what to expect when using <code>download-product</code>,
40-
see the <a href="../tasks.md#download-product"><code>download-product</code> task reference</a></p>
40+
see the <a href="../tasks.html#download-product"><code>download-product</code> task reference</a></p>
4141

4242
**Healthwatch**
4343

@@ -138,7 +138,7 @@ resource_types:
138138

139139
### Product resources
140140

141-
These are the S3 resources where Platform Automation Toolkit [`download-product`](../tasks.md#download-product) outputs will be stored.
141+
These are the S3 resources where Platform Automation Toolkit [`download-product`](../tasks.html#download-product) outputs will be stored.
142142
Each product/stemcell needs a separate resource defined.
143143
Platform Automation Toolkit will not create these resources for you.
144144

@@ -304,7 +304,7 @@ For more details, see [Inputs and outputs](../inputs-outputs.md).
304304
This example shows how to load secrets stored in an external credential manager such as CredHub.
305305
Concourse supports several [credential managers](https://concourse-ci.org/creds.html) natively.
306306

307-
The configuration below uses the [`prepare-tasks-with-secrets`](../tasks.md#prepare-tasks-with-secrets) task
307+
The configuration below uses the [`prepare-tasks-with-secrets`](../tasks.html#prepare-tasks-with-secrets) task
308308
to load secrets from your external configuration files.
309309

310310
```yaml

0 commit comments

Comments
 (0)