Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Broken Links (Starter Modules/Examples) in ALZ Accelerator Docs #9

Merged
merged 6 commits into from
Dec 9, 2024
Merged

Fix Broken Links (Starter Modules/Examples) in ALZ Accelerator Docs #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5f93112
Update bicepcomplete.md
alisakina99 Dec 5, 2024
d24ae30
Update terraformbasic.md
alisakina99 Dec 5, 2024
058b07b
Update terraformcompletemultiregion.md
alisakina99 Dec 5, 2024
100a164
Update terraformhubnetworking.md
alisakina99 Dec 5, 2024
dd41dbf
Update terrafromcompletevnext.md
alisakina99 Dec 5, 2024
6c1694b
Update terraformcompletemultiregion.md
alisakina99 Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/content/accelerator/startermodules/bicepcomplete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ Example input files can be found here:
[//]: # (INSERT LINK LABELS BELOW)
[//]: # (************************)

[example_powershell_inputs_azure_devops_bicep_complete]: examples/powershell-inputs/inputs-azure-devops-bicep-complete.yaml "Example - PowerShell Inputs - Azure DevOps - Bicep - Complete"
[example_powershell_inputs_github_bicep_complete]: examples/powershell-inputs/inputs-github-bicep-complete.yaml "Example - PowerShell Inputs - GitHub - Bicep - Complete"
[example_powershell_inputs_local_bicep_complete]: examples/powershell-inputs/inputs-local-bicep-complete.yaml "Example - PowerShell Inputs - Local - Bicep - Complete"
[example_powershell_inputs_azure_devops_bicep_complete]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-azure-devops-bicep-complete.yaml "Example - PowerShell Inputs - Azure DevOps - Bicep - Complete"
[example_powershell_inputs_github_bicep_complete]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-github-bicep-complete.yaml "Example - PowerShell Inputs - GitHub - Bicep - Complete"
[example_powershell_inputs_local_bicep_complete]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-local-bicep-complete.yaml "Example - PowerShell Inputs - Local - Bicep - Complete"
6 changes: 3 additions & 3 deletions docs/content/accelerator/startermodules/terraformbasic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ The following table describes the inputs required for the `basic` starter module
[//]: # (INSERT LINK LABELS BELOW)
[//]: # (************************)

[example_powershell_inputs_azure_devops_terraform_basic]: examples/powershell-inputs/inputs-azure-devops-terraform-basic.yaml "Example - PowerShell Inputs - Azure DevOps - Terraform - Basic"
[example_powershell_inputs_github_terraform_basic]: examples/powershell-inputs/inputs-github-terraform-basic.yaml "Example - PowerShell Inputs - GitHub - Terraform - Basic"
[example_powershell_inputs_local_terraform_basic]: examples/powershell-inputs/inputs-local-terraform-basic.yaml "Example - PowerShell Inputs - Local - Terraform - Basic"
[example_powershell_inputs_azure_devops_terraform_basic]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-azure-devops-terraform-basic.yaml "Example - PowerShell Inputs - Azure DevOps - Terraform - Basic"
[example_powershell_inputs_github_terraform_basic]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-github-terraform-basic.yaml "Example - PowerShell Inputs - GitHub - Terraform - Basic"
[example_powershell_inputs_local_terraform_basic]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-local-terraform-basic.yaml "Example - PowerShell Inputs - Local - Terraform - Basic"
16 changes: 8 additions & 8 deletions docs/content/accelerator/startermodules/terraformcompletemultiregion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,16 @@ The following tables describe the inputs required for the `complete_multi_region

Example ALZ PowerShell input files can be found here:

- [inputs-azure-devops-terraform-complete-multi-region.yaml][example_powershell_inputs_azure_devops_terraform_complete_multi_region]
- [inputs-github-terraform-complete-multi-region.yaml][example_powershell_inputs_github_terraform_complete_multi_region]
- [inputs-local-terraform-complete-multi-region.yaml][example_powershell_inputs_local_terraform_complete_multi_region]
- [inputs-azure-devops-terraform-complete-multi-region.yaml](https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-azure-devops-terraform-complete-multi-region.yaml)
- [inputs-github-terraform-complete-multi-region.yaml](https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-github-terraform-complete-multi-region.yaml)
- [inputs-local-terraform-complete-multi-region.yaml](https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-local-terraform-complete-multi-region.yaml)

Example network technology specific input files can be found here:

- Multi region hub and spoke virtual network: [config-hub-and-spoke-vnet-multi-region.yaml][example_starter_module_complete_config_hub_spoke_multi_region]
- Multi region virtual WAN: [config-virtual-wan-multi-region.yaml][example_starter_module_complete_config_vwan_multi_region]
- Single region hub and spoke virtual network: [config-hub-and-spoke-vnet-single-region.yaml][example_starter_module_complete_config_hub_spoke_single_region]
- Single region virtual WAN: [config-virtual-wan-single-region.yaml][example_starter_module_complete_config_vwan_single_region]
- Multi region hub and spoke virtual network: [config-hub-and-spoke-vnet-multi-region.yaml](https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/starter-module-config/complete-multi-region/config-hub-and-spoke-vnet-multi-region.yaml)
- Multi region virtual WAN: [config-virtual-wan-multi-region.yaml](https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/starter-module-config/complete-multi-region/config-virtual-wan-multi-region.yaml)
- Single region hub and spoke virtual network: [config-hub-and-spoke-vnet-single-region.yaml](https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/starter-module-config/complete-multi-region/config-hub-and-spoke-vnet-single-region.yaml)
- Single region virtual WAN: [config-virtual-wan-single-region.yaml](https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/starter-module-config/complete-multi-region/config-virtual-wan-single-region.yaml)

## Further details on the Complete Multi Region Starter Module and config file

Expand All @@ -55,7 +55,7 @@ The example config files have helpful templated variables such as `starter_locat

### High Level Design

![Alt text](./media/starter-module-hubnetworking.png)
![Alt text](Azure-Landing-Zones/docs/content/accelerator/startermodules/terraformcomplete/img/starter-module-hubnetworking.png)

### Terraform Modules

Expand Down
6 changes: 3 additions & 3 deletions docs/content/accelerator/startermodules/terraformhubnetworking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ The following table describes the inputs required for the `hubnetworking` starte
[//]: # (INSERT LINK LABELS BELOW)
[//]: # (************************)

[example_powershell_inputs_azure_devops_terraform_hubnetworking]: examples/powershell-inputs/inputs-azure-devops-terraform-hubnetworking.yaml "Example - PowerShell Inputs - Azure DevOps - Terraform - Hub Networking"
[example_powershell_inputs_github_terraform_hubnetworking]: examples/powershell-inputs/inputs-github-terraform-hubnetworking.yaml "Example - PowerShell Inputs - GitHub - Terraform - Hub Networking"
[example_powershell_inputs_local_terraform_hubnetworking]: examples/powershell-inputs/inputs-local-terraform-hubnetworking.yaml "Example - PowerShell Inputs - Local - Terraform - Hub Networking"
[example_powershell_inputs_azure_devops_terraform_hubnetworking]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-azure-devops-terraform-hubnetworking.yaml "Example - PowerShell Inputs - Azure DevOps - Terraform - Hub Networking"
[example_powershell_inputs_github_terraform_hubnetworking]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-github-terraform-hubnetworking.yaml "Example - PowerShell Inputs - GitHub - Terraform - Hub Networking"
[example_powershell_inputs_local_terraform_hubnetworking]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-local-terraform-hubnetworking.yaml "Example - PowerShell Inputs - Local - Terraform - Hub Networking"
12 changes: 6 additions & 6 deletions docs/content/accelerator/startermodules/terrafromcompletevnext.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ Create a custom yaml config to tailor to your needs, for example an Azure Landin
[//]: # (INSERT LINK LABELS BELOW)
[//]: # (************************)

[wiki_yaml_schema_reference]: %5BUser-Guide%5D-YAML-Schema-Reference "Wiki - YAML Schema Reference"
[example_starter_module_complete_vnext_config_hub_spoke]: examples/starter-module-config/complete_vnext/config-hub-spoke.yaml "Example - Starter Module Config - Complete - Hub and Spoke"
[example_starter_module_complete_vnext_config_vwan]: examples/starter-module-config/complete_vnext/config-vwan.yaml "Example - Starter Module Config - Complete - Virtual WAN"
[example_powershell_inputs_azure_devops_terraform_complete_vnext]: examples/powershell-inputs/inputs-azure-devops-terraform-complete_vnext.yaml "Example - PowerShell Inputs - Azure DevOps - Terraform - Complete vNext"
[example_powershell_inputs_github_terraform_complete_vnext]: examples/powershell-inputs/inputs-github-terraform-complete_vnext.yaml "Example - PowerShell Inputs - GitHub - Terraform - Complete vNext"
[example_powershell_inputs_local_terraform_complete_vnext]: examples/powershell-inputs/inputs-local-terraform-complete_vnext.yaml "Example - PowerShell Inputs - Local - Terraform - Complete vNext"
[wiki_yaml_schema_reference]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/%5BUser-Guide%5D-YAML-Schema-Reference.md "Wiki - YAML Schema Reference"
[example_starter_module_complete_vnext_config_hub_spoke]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/starter-module-config/complete/config-hub-spoke.yaml "Example - Starter Module Config - Complete - Hub and Spoke"
[example_starter_module_complete_vnext_config_vwan]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/starter-module-config/complete/config-vwan.yaml "Example - Starter Module Config - Complete - Virtual WAN"
[example_powershell_inputs_azure_devops_terraform_complete_vnext]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-azure-devops-terraform-complete-vnext.yaml "Example - PowerShell Inputs - Azure DevOps - Terraform - Complete vNext"
[example_powershell_inputs_github_terraform_complete_vnext]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-github-terraform-complete-vnext.yaml "Example - PowerShell Inputs - GitHub - Terraform - Complete vNext"
[example_powershell_inputs_local_terraform_complete_vnext]: https://raw.githubusercontent.com/Azure/ALZ-PowerShell-Module/refs/heads/main/docs/wiki/examples/powershell-inputs/inputs-local-terraform-complete-vnext.yaml "Example - PowerShell Inputs - Local - Terraform - Complete vNext"
Loading