Skip to content

Commit 7da5e9e

Browse files
octonautcalclaude
octonautcal
and
claude
committed
Fix pre-existing markdownlint violations in touched SPF pages
CI lint fails on any violation in a linted file, not just new ones, so clean up the existing issues in the files this PR already edits. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
1 parent c1af5e4 commit 7da5e9e

3 files changed

Lines changed: 28 additions & 28 deletions

File tree

‎src/pages/docs/infrastructure/deployment-targets/dynamic-infrastructure/index.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Building on the Web App example, you may wish to spin up an application and then
112112

113113
Using as little as two lines of PowerShell you can remove all the resources from Azure and Octopus:
114114

115-
```
115+
```powershell
116116
Remove-AzureRmResourceGroup -Name "AzureWebAppResourceGroup" -Force
117117
Remove-OctopusTarget -targetIdOrName "AzureWebApp"
118118
```
@@ -121,12 +121,12 @@ Remove-OctopusTarget -targetIdOrName "AzureWebApp"
121121

122122
You can also use the above PowerShell cmdlets when deploying Azure resources using an ARM template.
123123

124-
Firstly, turn on **Custom deployment scripts** under _Configure Features_ on your _Deploy an Azure Resource Group_ step.
124+
Firstly, turn on **Custom deployment scripts** under *Configure Features* on your *Deploy an Azure Resource Group* step.
125125

126126
:::figure
127127
![Configure features on ARM template step](/docs/img/infrastructure/deployment-targets/dynamic-infrastructure/arm-template-step-configure-features.png)
128128
:::
129129

130-
Under the _Features_ section you will have _Pre-deployment_, _Deployment_, and _Post-deployment_ scripts.
130+
Under the *Features* section you will have *Pre-deployment*, *Deployment*, and *Post-deployment* scripts.
131131

132-
In the _Post-deployment_ script section, you can [access the output parameters](/docs/runbooks/runbook-examples/azure/resource-groups/#arm-template-out-params) and use those output parameters to run any of the cmdlets above.
132+
In the *Post-deployment* script section, you can [access the output parameters](/docs/runbooks/runbook-examples/azure/resource-groups/#arm-template-out-params) and use those output parameters to run any of the cmdlets above.

‎src/pages/docs/infrastructure/deployment-targets/dynamic-infrastructure/new-octopustarget.mdx‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,25 @@ To create a target defined by a step package, you will need to know the `target
3030

3131
Command (pwsh): **New-OctopusTarget**
3232

33-
| Parameter | Value |
34-
| --------------------- | ----------------------------------------------------------------------------- |
35-
| `-name` | The Name of the target to create |
36-
| `-targetId` | The target identifier of target to create |
37-
| `-inputs` | The inputs required to define the target being created |
38-
| `-roles` | Comma separated list of [target tags](/docs/infrastructure/deployment-targets/target-tags) to assign |
39-
| `-updateIfExisting` | Will update an existing target with the same name, create if it doesn't exist |
40-
| `-workerPoolIdOrName` | Name or Id of the Worker Pool for the deployment target to use. (Optional) |
33+
| Parameter | Value |
34+
| --------------------- | ------------------------------------------------------------------------------------------------------ |
35+
| `-name` | The Name of the target to create |
36+
| `-targetId` | The target identifier of target to create |
37+
| `-inputs` | The inputs required to define the target being created |
38+
| `-roles` | Comma separated list of [target tags](/docs/infrastructure/deployment-targets/target-tags) to assign |
39+
| `-updateIfExisting` | Will update an existing target with the same name, create if it doesn't exist |
40+
| `-workerPoolIdOrName` | Name or Id of the Worker Pool for the deployment target to use. (Optional) |
4141

4242
Command (bash) **new_octopustarget**
4343

44-
| Parameter | Value |
45-
| ---------------------- | ----------------------------------------------------------------------------- |
46-
| `-n` \| `--name` | The Name of the target to create |
47-
| `-t` \| `--targetId` | The target identifier of target to create |
48-
| `--inputs` | The inputs required to define the target being created |
49-
| `--roles` | Comma separated list of [target tags](/docs/infrastructure/deployment-targets/target-tags) to assign |
50-
| `--update-if-existing` | Will update an existing target with the same name, create if it doesn't exist |
51-
| `--worker-pool` | Name or Id of the Worker Pool for the deployment target to use. (Optional) |
44+
| Parameter | Value |
45+
| ---------------------- | ------------------------------------------------------------------------------------------------------ |
46+
| `-n` \| `--name` | The Name of the target to create |
47+
| `-t` \| `--targetId` | The target identifier of target to create |
48+
| `--inputs` | The inputs required to define the target being created |
49+
| `--roles` | Comma separated list of [target tags](/docs/infrastructure/deployment-targets/target-tags) to assign |
50+
| `--update-if-existing` | Will update an existing target with the same name, create if it doesn't exist |
51+
| `--worker-pool` | Name or Id of the Worker Pool for the deployment target to use. (Optional) |
5252

5353
### Examples
5454

@@ -217,4 +217,4 @@ new_octopustarget -n "$(get_octopusvariable "target_name")" -t "aws-ecs-target"
217217
218218
</details>
219219
220-
<CreateDeploymentTargetsHint />
220+
<CreateDeploymentTargetsHint />

‎src/pages/docs/projects/built-in-step-templates/automatic-updates.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,21 @@ Built-in step templates that use the new "step package" format can be updated au
1919
Optionally, the automatic version updates of built-in steps can be turned off by navigating to **Configuration ➜ Features** and turning off the **Step Template Updates** feature.
2020

2121
:::figure
22-
![](/docs/img/projects/built-in-step-templates/images/automatic-updates-configuration.png)
22+
![Step Template Updates feature toggle in Configuration ➜ Features](/docs/img/projects/built-in-step-templates/images/automatic-updates-configuration.png)
2323
:::
2424

2525
## Notes
2626

27-
* Existing deployment processes and runbooks will be automatically updated to use the latest **minor version** of the built-in step templates, without any user-intervention. This enables rapid deployment of security and patch fixes in a backward compatible manner.
28-
* **Major version** upgrades of steps within existing deployment processes and runbooks will require manual intervention, as the steps will not be backward compatible and likely require additional input.
27+
- Existing deployment processes and runbooks will be automatically updated to use the latest **minor version** of the built-in step templates, without any user-intervention. This enables rapid deployment of security and patch fixes in a backward compatible manner.
28+
- **Major version** upgrades of steps within existing deployment processes and runbooks will require manual intervention, as the steps will not be backward compatible and likely require additional input.
2929

3030
:::figure
31-
![](/docs/img/projects/built-in-step-templates/images/step-migration-v2.png)
31+
![Step migration prompt shown for a major version upgrade](/docs/img/projects/built-in-step-templates/images/step-migration-v2.png)
3232
:::
3333

34-
* Only steps that are compatible with the current Octopus Server version will be automatically downloaded and updated.
35-
* Only the steps built with the new "step package" format are updated using the described mechanism. Existing steps will still require Octopus to be updated to receive new versions.
34+
- Only steps that are compatible with the current Octopus Server version will be automatically downloaded and updated.
35+
- Only the steps built with the new "step package" format are updated using the described mechanism. Existing steps will still require Octopus to be updated to receive new versions.
3636

3737
## Older versions
3838

39-
Automatic step template updates are available from Octopus **2022.1**.
39+
Automatic step template updates are available from Octopus **2022.1**.

0 commit comments

Comments
 (0)