Skip to content

Commit

Permalink
Shorten variable name
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredfholgate committed Jul 10, 2024
1 parent e2c8061 commit d874e4f
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/wiki/[User-Guide]-Quick-Start-Phase-2-Azure-DevOps.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Although you can just run `Deploy-Accelerator` and fill out the prompted inputs,
| `azure_devops_personal_access_token` | `<token-1>` | Replace `<token-1>` with the `token-1` Azure DevOps PAT you generated in a previous step. |
| `azure_devops_agents_personal_access_token` | `<token-2>` | Replace `<token-2>` with the `token-2` Azure DevOps PAT you generated in the previous step specifically for the self-hosted agents. This only applies if you have `use_self_hosted_agents` set to `true`. You can set this to an empty string `""` if you are not using self-hosted agents. |
| `azure_devops_organization_name` | `<azure-devops-organization>` | Replace `<azure-devops-organization>` with the name of your Azure DevOps organization. This is the section of the url after `dev.azure.com` or before `.visualstudio.com`. E.g. enter `my-org` for `https://dev.azure.com/my-org`. |
| `use_separate_repository_for_pipeline_templates` | `true` | Determine whether to create a separate repository to store pipeline templates as an extra layer of security. Set to `false` if you don't wish to secure your pipeline templates by using a separate repository. This will default to `true`. |
| `use_separate_repository_for_templates` | `true` | Determine whether to create a separate repository to store pipeline templates as an extra layer of security. Set to `false` if you don't wish to secure your pipeline templates by using a separate repository. This will default to `true`. |
| `bootstrap_location` | `<region>` | Replace `<region>` with the Azure region where you would like to deploy the bootstrap resources in Azure. This field expects the `name` of the region, such as `uksouth`. You can find a full list of names by running `az account list-locations -o table`. |
| `bootstrap_subscription_id` | `<bootstrap-subscription-id>` | Replace `<subscription-id>` with the id of the subscription in which you would like to deploy the bootstrap resources in Azure. If left blank, the subscription you are connected to via `az login` will be used. In most cases this is the management subscription, but you can specifiy a separate subscription if you prefer. |
| `service_name` | `alz` | This is used to build up the names of your Azure and Azure DevOps resources, for example `rg-<service_name>-mgmt-uksouth-001`. We recommend using `alz` for this. |
Expand Down Expand Up @@ -93,7 +93,7 @@ Although you can just run `Deploy-Accelerator` and fill out the prompted inputs,
| `azure_devops_personal_access_token` | `<token-1>` | Replace `<token-1>` with the `token-1` Azure DevOps PAT you generated in a previous step. |
| `azure_devops_agents_personal_access_token` | `<token-2>` | Replace `<token-2>` with the `token-2` Azure DevOps PAT you generated in the previous step specifically for the self-hosted agents. This only applies if you have `use_self_hosted_agents` set to `true`. You can set this to an empty string `""` if you are not using self-hosted agents. |
| `azure_devops_organization_name` | `<azure-devops-organization>` | Replace `<azure-devops-organization>` with the name of your Azure DevOps organization. This is the section of the url after `dev.azure.com` or before `.visualstudio.com`. E.g. enter `my-org` for `https://dev.azure.com/my-org`. |
| `use_separate_repository_for_pipeline_templates` | `true` | Determine whether to create a separate repository to store pipeline templates as an extra layer of security. Set to `false` if you don't wish to secure your pipeline templates by using a separate repository. This will default to `true`. |
| `use_separate_repository_for_templates` | `true` | Determine whether to create a separate repository to store pipeline templates as an extra layer of security. Set to `false` if you don't wish to secure your pipeline templates by using a separate repository. This will default to `true`. |
| `bootstrap_location` | `<region>` | Replace `<region>` with the Azure region where you would like to deploy the bootstrap resources in Azure. This field expects the `name` of the region, such as `uksouth`. You can find a full list of names by running `az account list-locations -o table`. |
| `bootstrap_subscription_id` | `<bootstrap-subscription-id>` | Replace `<subscription-id>` with the id of the subscription in which you would like to deploy the bootstrap resources in Azure. If left blank, the subscription you are connected to via `az login` will be used. In most cases this is the management subscription, but you can specifiy a separate subscription if you prefer. |
| `service_name` | `alz` | This is used to build up the names of your Azure and Azure DevOps resources, for example `rg-<service_name>-mgmt-uksouth-001`. We recommend using `alz` for this. |
Expand Down
4 changes: 2 additions & 2 deletions docs/wiki/[User-Guide]-Quick-Start-Phase-2-GitHub.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Although you can just run `Deploy-Accelerator` and fill out the prompted inputs,
| `github_personal_access_token` | `<token-1>` | Replace `<token-1>` with the `token-1` GitHub PAT you generated in a previous step. |
| `github_runners_personal_access_token` | `<token-2>` | Replace `<token-2>` with the `token-2` GitHub PAT you generated in the previous step specifically for the self-hosted runners. This only applies if you have `use_self_hosted_agents` set to `true`. You can set this to an empty string `""` if you are not using self-hosted runners. |
| `github_organization_name` | `<github-organization>` | Replace `<github-organization>` with the name of your Azure DevOps organization. This is the section of the url after `github.com`. E.g. enter `my-org` for `https://github.com/my-org`. |
| `use_separate_repository_for_workflow_templates` | `true` | Determine whether to create a separate repository to store workflow templates as an extra layer of security. Set to `false` if you don't wish to secure your workflow templates by using a separate repository. This will default to `true`. |
| `use_separate_repository_for_templates` | `true` | Determine whether to create a separate repository to store workflow templates as an extra layer of security. Set to `false` if you don't wish to secure your workflow templates by using a separate repository. This will default to `true`. |
| `bootstrap_location` | `<region>` | Replace `<region>` with the Azure region where you would like to deploy the bootstrap resources in Azure. This field expects the `name` of the region, such as `uksouth`. You can find a full list of names by running `az account list-locations -o table`. |
| `bootstrap_subscription_id` | `<bootstrap-subscription-id>` | Replace `<subscription-id>` with the id of the subscription in which you would like to deploy the bootstrap resources in Azure. If left blank, the subscription you are connected to via `az login` will be used. In most cases this is the management subscription, but you can specifiy a separate subscription if you prefer. |
| `service_name` | `alz` | This is used to build up the names of your Azure and Azure DevOps resources, for example `rg-<service_name>-mgmt-uksouth-001`. We recommend using `alz` for this. |
Expand Down Expand Up @@ -90,7 +90,7 @@ Although you can just run `Deploy-Accelerator` and fill out the prompted inputs,
| `github_personal_access_token` | `<token-1>` | Replace `<token-1>` with the `token-1` GitHub PAT you generated in a previous step. |
| `github_runners_personal_access_token` | `<token-2>` | Replace `<token-2>` with the `token-2` GitHub PAT you generated in the previous step specifically for the self-hosted runners. This only applies if you have `use_self_hosted_agents` set to `true`. You can set this to an empty string `""` if you are not using self-hosted runners. |
| `github_organization_name` | `<github-organization>` | Replace `<github-organization>` with the name of your Azure DevOps organization. This is the section of the url after `github.com`. E.g. enter `my-org` for `https://github.com/my-org`. |
| `use_separate_repository_for_workflow_templates` | `true` | Determine whether to create a separate repository to store workflow templates as an extra layer of security. Set to `false` if you don't wish to secure your workflow templates by using a separate repository. This will default to `true`. |
| `use_separate_repository_for_templates` | `true` | Determine whether to create a separate repository to store workflow templates as an extra layer of security. Set to `false` if you don't wish to secure your workflow templates by using a separate repository. This will default to `true`. |
| `bootstrap_location` | `<region>` | Replace `<region>` with the Azure region where you would like to deploy the bootstrap resources in Azure. This field expects the `name` of the region, such as `uksouth`. You can find a full list of names by running `az account list-locations -o table`. |
| `bootstrap_subscription_id` | `<bootstrap-subscription-id>` | Replace `<subscription-id>` with the id of the subscription in which you would like to deploy the bootstrap resources in Azure. If left blank, the subscription you are connected to via `az login` will be used. In most cases this is the management subscription, but you can specifiy a separate subscription if you prefer. |
| `service_name` | `alz` | This is used to build up the names of your Azure and Azure DevOps resources, for example `rg-<service_name>-mgmt-uksouth-001`. We recommend using `alz` for this. |
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/_Footer.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- markdownlint-disable-next-line no-emphasis-as-heading first-line-h1 -->
**This wiki is being actively developed**

If you discover any documentation bugs or would like to request new content, please raise them as an [issue](https://github.com/Azure/alz-terraform-accelerator/issues) or feel free to contribute to the wiki via a [pull request](https://github.com/Azure/alz-terraform-accelerator/pulls). The wiki docs are located in the repository in the `docs/wiki/` folder.
If you discover any documentation bugs or would like to request new content, please raise them as an [issue](https://github.com/Azure/ALZ-PowerShell-Module/issues) or feel free to contribute to the wiki via a [pull request](https://github.com/Azure/ALZ-PowerShell-Module/pulls). The wiki docs are located in the repository in the `docs/wiki/` folder.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ azure_devops_personal_access_token: "<token-1>"
azure_devops_agents_personal_access_token: "<token-2>"
azure_devops_organization_name: "<azure-devops-organization>"
bootstrap_location: "<region>"
use_separate_repository_for_pipeline_templates: "true"
use_separate_repository_for_templates: "true"
bootstrap_subscription_id: "<bootstrap-subscription-id>"
service_name: "alz"
environment_name: "mgmt"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ azure_devops_personal_access_token: "<token-1>"
azure_devops_agents_personal_access_token: "<token-2>"
azure_devops_organization_name: "<azure-devops-organization>"
bootstrap_location: "<region>"
use_separate_repository_for_pipeline_templates: "true"
use_separate_repository_for_templates: "true"
bootstrap_subscription_id: "<bootstrap-subscription-id>"
service_name: "alz"
environment_name: "mgmt"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ github_personal_access_token: "<token-1>"
github_runners_personal_access_token: "<token-2>"
github_organization_name: "<github-organization>"
bootstrap_location: "<region>"
use_separate_repository_for_workflow_templates: "true"
use_separate_repository_for_templates: "true"
bootstrap_subscription_id: "<bootstrap-subscription-id>"
service_name: "alz"
environment_name: "mgmt"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ github_personal_access_token: "<token-1>"
github_runners_personal_access_token: "<token-2>"
github_organization_name: "<github-organization>"
bootstrap_location: "<region>"
use_separate_repository_for_workflow_templates: "true"
use_separate_repository_for_templates: "true"
bootstrap_subscription_id: "<bootstrap-subscription-id>"
service_name: "alz"
environment_name: "mgmt"
Expand Down

0 comments on commit d874e4f

Please sign in to comment.