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.

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

Broken URL Clean-up in Mattermost Docs #7581

Open
yesbhautik opened this issue Nov 9, 2024 · 5 comments
Open

Broken URL Clean-up in Mattermost Docs #7581

yesbhautik opened this issue Nov 9, 2024 · 5 comments
Assignees
Milestone

Comments

@yesbhautik
Copy link
Contributor

yesbhautik commented Nov 9, 2024

hi, @cwarnermm. I have scanned the all URLs mentioned over dev docs site. I found many broken links during scan.

Here is the list of Broken links:

	Line  3165: ├─BROKEN─ https://github.com/irdiOL (HTTP_404)
	Line  3185: ├─BROKEN─ https://github.com/k4awon (HTTP_404)
	Line  4992: ├─BROKEN─ https://github.com/vicky-demansol (HTTP_404)
	Line  5048: ├─BROKEN─ https://github.com/Bhavin789 (HTTP_404)
	Line  5796: ├─BROKEN─ https://github.com/mattermost/focalboard/discussions/566 (HTTP_404)
	Line  8580: ├─BROKEN─ https://github.com/anuragbhd (HTTP_404)
	Line  8890: ├─BROKEN─ https://github.com/dependabot%5Bbot%5D (HTTP_404)
	Line  9109: ├─BROKEN─ https://github.com/com/comharris (HTTP_404)
	Line 10265: ├─BROKEN─ https://github.com/mattermost/enahum (HTTP_404)
	Line 10273: ├─BROKEN─ https://github.com/mattermost/longsleep (HTTP_404)
	Line 10278: ├─BROKEN─ https://github.com/mattermost/santos22 (HTTP_404)
	Line 10499: ├─BROKEN─ https://github.com/mattermost/crspeller (HTTP_404)
	Line 11243: ├─BROKEN─ https://github.com/mattermost/mattermost-server/tree/master/tests (HTTP_404)
	Line 12099: ├─BROKEN─ https://github.com/mattermost/desktop/releases/tag/v5.6.0%3E (HTTP_404)
	Line 12381: ├─BROKEN─ https://github.com/mattermost/mattermost-mobile/releases/tag/v2.9.1 (HTTP_404)
	Line 13127: ├─BROKEN─ https://github.com/mattermost/focalboard/discussions/566 (HTTP_404)
	Line 13357: ├─BROKEN─ https://support.google.com/android/answer/9075928?hl=en (HTTP_404)
	Line 13416: ├─BROKEN─ https://support.google.com/a/answer/2956491?hl=en (HTTP_404)
	Line 13425: ├─BROKEN─ https://docs.ranchermanager.rancher.io/v2.0-v2.4/pages-for-subheaders/helm2-helm-init (HTTP_404)
	Line 14451: ├─BROKEN─ https://docs.mattermost.com/configure/www.xunsearch.com/scws/docs.php (HTTP_404)
	Line 14503: ├─BROKEN─ https://github.com/mattermost/mattermost-server/blob/master/services/telemetry/telemetry.go#L1406 (HTTP_404)
	Line 15426: ├─BROKEN─ https://github.com/mattermost/mattermost-plugin-msteams/blob/main/server/metrics/dashboards/cloud.json (HTTP_404)
	Line 15595: └─BROKEN─ https://docs.mattermost.com/maximize-microsoft-investment.html (HTTP_404)
	Line 15656: ├─BROKEN─ https://github.com/invalid-email-address (HTTP_404)

Possible Solutions

  • Change that specific URL
  • Remove broken links from docs
  • Rewrite/remove text content where link mentioned.
  • Activate the URL // Set the redirection on that URL

NOTE: I was getting error to scan all URL, because number of URLs is very high like more than 15-20000. So we may have to re-scan the site.

@cwarnermm
Copy link
Member

Thanks, @yesbhautik! Are you interested in opening a dev docs PR to fix these links?

@cwarnermm
Copy link
Member

Thanks, @yesbhautik! You're seeing the same results I am with the scanning tools I'm using to check links across the docs site. You'll find that many of those 404s reported are live and working as expected and just slow to respond and tend to time out before resolution.

@yesbhautik
Copy link
Contributor Author

Thanks, @yesbhautik! You're seeing the same results I am with the scanning tools I'm using to check links across the docs site. You'll find that many of those 404s reported are live and working as expected and just slow to respond and tend to time out before resolution.

That's true @cwarnermm. I found many of BROKEN links, but that were working properly. But, don’t worry, above-mentioned URLs is manually tested.

@yesbhautik
Copy link
Contributor Author

Thanks, @yesbhautik! Are you interested in opening a dev docs PR to fix these links?

Sure, which possible solution would we use?

@cwarnermm
Copy link
Member

I'll review the links here identified as broken and fix where needed since I'm wrapping up the v10.2 documentation updates today for a release tomorrow.

For the other docs areas where you've reported broken links, the manual way forward is to review each identified broken link in a browser to see if it resolves as expected. If it does, there's nothing to fix. If it doesn't, that link may need an update (particularly if you're redirected to another URL).

@cwarnermm cwarnermm self-assigned this Nov 14, 2024
@cwarnermm cwarnermm added this to the v10.2.0 milestone Nov 14, 2024
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

No branches or pull requests

2 participants