Azure / terraform-azurerm-caf-enterprise-scale

Azure landing zones Terraform module
https://aka.ms/alz/tf
MIT License
830 stars 544 forks source link

Broken Wiki Links #1094

Closed sissonsrob closed 2 weeks ago

sissonsrob commented 3 weeks ago

Community Note

Versions

terraform: 1.7.0

azure provider: 3.65.0

module: 6.0.0

Description

Describe the bug

Broken links in wiki since rename of files

Steps to Reproduce

  1. Navigate to the wiki
  2. Select any link which refers to multi-region networking with custom settings (hub/spoke and vwan) - including side bar
  3. links are broken and send you 'home'

Screenshots

n/a

Additional context

looks like the files were renamed in this commit but the links on the sidebar and other pages were not updated.

https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/commit/b7bff069ad321d329a6090231eac2fd0dd95d83e

I have raised a PR to fix the links but there may also be a desire to rename the link descriptions?

I tried to raise a PR but the bot didn't trigger and I received an error advising that I aren't a collaborator :/

AndrewBatchelorWpp commented 3 weeks ago

I also observed this issue, the broken link is: https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/wiki/%5BExamples%5D-Deploy-Virtual-WAN-Resources-With-Custom-Settings

I found this page, which I assume is the missing one: https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/blob/main/docs/wiki/%5BExamples%5D-Deploy-Virtual-WAN-Multi-Region-With-Custom-Settings.md

I would also advise users of CAF module to look at: https://azure.github.io/Azure-Verified-Modules/ and https://registry.terraform.io/modules/Azure/avm-ptn-virtualwan/azurerm/latest (see also issue 731) as this seems to be superseding the connectivity capability in CAF module

sissonsrob commented 3 weeks ago

Yes, sorry I didn't add the full details above because I had intended on linking my PR - can anyone help with how I can trigger the bot to become a collaborator so I can submit the PR from my fork?

Otherwise the two broken links are:

https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/wiki/%5BExamples%5D-Deploy-Virtual-WAN-Multi-Region-With-Custom-Settings

and

https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/wiki/%5BExamples%5D-Deploy-Multi-Region-Networking-With-Custom-Settings

These two pages are referenced in the following places which need to have their links updated at the bottom of the pages to fix:

docs/wiki/Examples.md docs/wiki/[Examples]-Deploy-Connectivity-Resources.md docs/wiki/[Examples]-Deploy-Multi-Region-Networking-With-Custom-Settings.md docs/wiki/[Examples]-Deploy-Virtual-WAN-Multi-Region-With-Custom-Settings.md docs/wiki/[Examples]-Deploy-Virtual-WAN-Resources.md docs/wiki/[Examples]-Deploy-using-multiple-module-declarations-with-orchestration.md docs/wiki/[Examples]-Deploy-using-multiple-module-declarations-with-remote-state.md docs/wiki/_Sidebar.md

matt-FFFFFF commented 2 weeks ago

closed by #1110