Skip to content

Conversation

@Bojun-Feng
Copy link

@Bojun-Feng Bojun-Feng commented Dec 14, 2025

Updated broken links from previous documentation refactor.

Fix #2157
Fix (partially) sonic-net/sonic-buildimage#24867

Following is the issue description:

5cb28e3 results in multiple GitHub markdown files changing locations. This breaks their corresponding URLs in the repository.

Here is a list of the URLs changed:

- https://github.com/sonic-net/SONiC/blob/master/doc/auto_techsupport_and_coredump_mgmt.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/auto-techsupport/auto_techsupport_and_coredump_mgmt.md

- https://github.com/sonic-net/SONiC/blob/master/doc/Dump-Utility.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/dump-utility/Dump-Utility.md

- https://github.com/sonic-net/SONiC/blob/master/doc/SONiC%20feature%20quality%20definition.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/guidelines/SONiC%20feature%20quality%20definition.md

- https://github.com/sonic-net/SONiC/blob/master/doc/hld_template.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/guidelines/hld_template.md

- https://github.com/sonic-net/SONiC/blob/master/doc/Optional-Feature-Control.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/optional-feature-control/Optional-Feature-Control.md

- https://github.com/sonic-net/SONiC/blob/master/doc/pcieinfo_design.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/pcie-mon/pcieinfo_design.md

- https://github.com/sonic-net/SONiC/blob/master/doc/ssdhealth_design.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/ssdhealth/ssdhealth_design.md

- https://github.com/sonic-net/SONiC/blob/master/doc/SONiC-User-Manual.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/user-manual/SONiC-User-Manual.md

Note there are also broken links in the website and wikis. The corresponding code is either not public or not accepting community PRs, so I can not make a contribution to fix them directly.

The above code block are only the bad URLs found in the repository. In case you need it, here is a complete list of urls impacted by the refactor for easy find and replace:

All URLs Impacted By Doc Refactor
- https://github.com/sonic-net/SONiC/blob/master/sonic-acl.yang
+ https://github.com/sonic-net/SONiC/blob/master/doc/acl/sonic-acl.yang

- https://github.com/sonic-net/SONiC/blob/master/doc/asic_thermal_monitoring_hld.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/asic-thermal-monitoring/asic_thermal_monitoring_hld.md

- https://github.com/sonic-net/SONiC/blob/master/doc/auto_techsupport_and_coredump_mgmt.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/auto-techsupport/auto_techsupport_and_coredump_mgmt.md

- https://github.com/sonic-net/SONiC/blob/master/doc/config_db.json
+ https://github.com/sonic-net/SONiC/blob/master/doc/configuration/examples/config_db.json

- https://github.com/sonic-net/SONiC/blob/master/doc/config_db_t0.json
+ https://github.com/sonic-net/SONiC/blob/master/doc/configuration/examples/config_db_t0.json

- https://github.com/sonic-net/SONiC/blob/master/doc/debug_framework_design_spec.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/debug-framework/debug_framework_design_spec.md

- https://github.com/sonic-net/SONiC/blob/master/doc/DIP=SIP_HLD.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/dip-sip/DIP=SIP_HLD.md

- https://github.com/sonic-net/SONiC/blob/master/doc/Dump-Utility.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/dump-utility/Dump-Utility.md

- https://github.com/sonic-net/SONiC/blob/master/doc/SONiC%20feature%20quality%20definition.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/guidelines/SONiC%20feature%20quality%20definition.md

- https://github.com/sonic-net/SONiC/blob/master/doc/hld_template.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/guidelines/hld_template.md

- https://github.com/sonic-net/SONiC/blob/master/doc/SONIC_Test_Ingress_Discards_HLD.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/ingress-discards-test/SONIC_Test_Ingress_Discards_HLD.md

- https://github.com/sonic-net/SONiC/blob/master/doc/L3_performance_and_scaling_enchancements_HLD.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/l3-performance-scaling/L3_performance_and_scaling_enchancements_HLD.md

- https://github.com/sonic-net/SONiC/blob/master/doc/Optional-Feature-Control.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/optional-feature-control/Optional-Feature-Control.md

- https://github.com/sonic-net/SONiC/blob/master/doc/SONiC_local_users_password_reset_hld.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/password-reset/SONiC_local_users_password_reset_hld.md

- https://github.com/sonic-net/SONiC/blob/master/doc/reset-local-users-passwords-init.png
+ https://github.com/sonic-net/SONiC/blob/master/doc/password-reset/reset-local-users-passwords-init.png

- https://github.com/sonic-net/SONiC/blob/master/doc/pcieinfo_design.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/pcie-mon/pcieinfo_design.md

- https://github.com/sonic-net/SONiC/blob/master/doc/platform_json_enhancement.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/platform-json/platform_json_enhancement.md

- https://github.com/sonic-net/SONiC/blob/master/doc/Port_illegal_packets_drop_design.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/port-illegal-packets/Port_illegal_packets_drop_design.md

- https://github.com/sonic-net/SONiC/blob/master/doc/SONiC_Port_Mirroring_HLD.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/port-mirroring/SONiC_Port_Mirroring_HLD.md

- https://github.com/sonic-net/SONiC/blob/master/doc/ragile%20fancontrol%20hld.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/ragile-fancontrol/ragile%20fancontrol%20hld.md

- https://github.com/sonic-net/SONiC/blob/master/doc/SONiC%20201904%20Release%20Notes.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/release-notes/SONiC%20201904%20Release%20Notes.md

- https://github.com/sonic-net/SONiC/blob/master/doc/sonic-port-name.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/sonic-port-name/sonic-port-name.md

- https://github.com/sonic-net/SONiC/blob/master/doc/ssdhealth_design.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/ssdhealth/ssdhealth_design.md

- https://github.com/sonic-net/SONiC/blob/master/doc/TACACSPLUS_PASSKEY_ENCRYPTION.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/tacacs-passkey/TACACSPLUS_PASSKEY_ENCRYPTION.md

- https://github.com/sonic-net/SONiC/blob/master/doc/SONiC%20Test%20Plan%20Template.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/test-plans/SONiC%20Test%20Plan%20Template.md

- https://github.com/sonic-net/SONiC/blob/master/doc/Sonic%20Basic%20L2%20Mode%20Test%20plan.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/test-plans/Sonic%20Basic%20L2%20Mode%20Test%20plan.md

- https://github.com/sonic-net/SONiC/blob/master/doc/PW-1.png
+ https://github.com/sonic-net/SONiC/blob/master/doc/user-manual/PW-1.png

- https://github.com/sonic-net/SONiC/blob/master/doc/PW-2.png
+ https://github.com/sonic-net/SONiC/blob/master/doc/user-manual/PW-2.png

- https://github.com/sonic-net/SONiC/blob/master/doc/PW-3.png
+ https://github.com/sonic-net/SONiC/blob/master/doc/user-manual/PW-3.png

- https://github.com/sonic-net/SONiC/blob/master/doc/PW-4.png
+ https://github.com/sonic-net/SONiC/blob/master/doc/user-manual/PW-4.png

- https://github.com/sonic-net/SONiC/blob/master/doc/PW-5.png
+ https://github.com/sonic-net/SONiC/blob/master/doc/user-manual/PW-5.png

- https://github.com/sonic-net/SONiC/blob/master/doc/SONiC-User-Manual.md
+ https://github.com/sonic-net/SONiC/blob/master/doc/user-manual/SONiC-User-Manual.md

Updated broken links from previous documentation refactor.

Signed-off-by: Bojun Feng <[email protected]>
@mssonicbld
Copy link
Collaborator

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@Bojun-Feng Bojun-Feng changed the title Fix outdated links Fix Outdated Doc Links from Previous Doc Refactor Dec 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Outdated Links from Previous Doc Refactor

2 participants