edgexfoundry / edgex-docs

42 stars 85 forks source link

fix broken links in Kamakura/Levski #778

Closed jpwhitemn closed 2 years ago

jpwhitemn commented 2 years ago

🐞 Bug Report

The following links in the documentation where caught by a recent run of HTML Proofer. Looks like in Kamakura and Levski versions:

invalid url - https://github.com/edgexfoundry/edgex-examples/tree/v2.2.0/security/remote_devices/docker-swarm [404] [examples/index.md] invalid url - https://github.com/edgexfoundry/edgex-examples/tree/v2.2.0/security/remote_devices/ssh-tunneling [404] [examples/index.md] invalid url - https://github.com/lf-edge/ekuiper/blob/master/docs/en_US/rules/sources/edgex.md [404] [microservices/support/eKuiper/Ch-eKuiper.md] invalid url - https://github.com/lf-edge/ekuiper/blob/master/docs/en_US/rules/sinks/edgex.md [404] [microservices/support/eKuiper/Ch-eKuiper.md] invalid url - https://github.com/lf-edge/ekuiper/blob/master/docs/en_US/reference.md [404] [microservices/support/eKuiper/Ch-eKuiper.md] invalid url - https://support.google.com/accounts/answer/185833?hl=en [404] [microservices/support/notifications/Ch-AlertsNotifications.md] invalid url - https://support.google.com/accounts/answer/6010255?hl=en [404] [microservices/support/notifications/Ch-AlertsNotifications.md]

Description and Minimal Reproduction [REQUIRED]

run make serve with HTML Proofer on (uncomment last line of mkdocs.yml)

🔥 Exception or Error

🌍 Your Environment

Deployment Environment: Linux, Ubunt 20.04

EdgeX Version [REQUIRED]: kamakura or Levski (main)

Anything else relevant?

jpwhitemn commented 2 years ago

broken link issues in Levski have been fixed. Issues in Kamakura still remain.

jpwhitemn commented 2 years ago

Current list of broken links in Kamakura: invalid url - https://github.com/edgexfoundry/edgex-examples/tree/v2.2.0/security/remote_devices/docker-swarm [404] [examples/index.md] invalid url - https://github.com/edgexfoundry/edgex-examples/tree/v2.2.0/security/remote_devices/ssh-tunneling [404] [examples/index.md] invalid url - https://docs.docker.com/compose/install/compose-plugin/ [404] [getting-started/Ch-GettingStartedDockerUsers.md] invalid url - https://github.com/lf-edge/ekuiper/blob/master/docs/en_US/rules/sources/edgex.md [404] [microservices/support/eKuiper/Ch-eKuiper.md] invalid url - https://github.com/lf-edge/ekuiper/blob/master/docs/en_US/rules/sinks/edgex.md [404] [microservices/support/eKuiper/Ch-eKuiper.md] invalid url - https://github.com/lf-edge/ekuiper/blob/master/docs/en_US/reference.md [404] [microservices/support/eKuiper/Ch-eKuiper.md] invalid url - https://support.google.com/accounts/answer/185833?hl=en [404] [microservices/support/notifications/Ch-AlertsNotifications.md] invalid url - https://support.google.com/accounts/answer/6010255?hl=en [404] [microservices/support/notifications/Ch-AlertsNotifications.md]

jpwhitemn commented 2 years ago

bottom two invalid URLs pointing to google pages in Alerts-Notifications area have been addressed.