mattermost / mattermost/mattermost-developer-documentation
Broken URL Clean-up in dev Docs
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 90
- Forks
- 460
- Avg merge
- 9d 23h
- Merged PRs (30d)
- 2
Description
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 546: ├─BROKEN─ https://docs.mattermost.com/config-ssl-http2-nginx.html (HTTP_404)
Line 782: ├─BROKEN─ https://react.dev/docs/react-dom.html (HTTP_404)
Line 968: ├─BROKEN─ https://www.microsoft.com/en-us/language/Search (HTTP_404)
Line 1248: ├─BROKEN─ https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/tests/setup.js (HTTP_404)
Line 1284: ├─BROKEN─ https://github.com/mattermost/mattermost/blob/master/e2e-tests/cypress/tests/support/api/user.d.ts (HTTP_404)
Line 1287: ├─BROKEN─ https://chrome.google.com/webstore/detail/testing-playground/hejbmebodbijjdhflfknehhcgaklhano/related (HTTP_404)
Line 1835: ├─BROKEN─ https://github.com/mattermost/desktop/blob/master/src/main/windows/settingsWindow.ts (HTTP_404)
Line 2085: ├─BROKEN─ https://github.com/matthew-src (HTTP_404)
Line 2105: ├─BROKEN─ https://github.com/XxLilBoPeepsxX (HTTP_404)
Line 2234: ├─BROKEN─ https://github.com/mattermost/mattermost-webapp/blob/master/entry.js (HTTP_404)
Line 2287: ├─BROKEN─ https://github.com/mattermost/mattermost/blob/master/config.mk (HTTP_404)
Line 2290: ├─BROKEN─ https://grafana.com/grafana/dashboards/2542 (HTTP_404)
Line 2372: ├─BROKEN─ https://github.com/mattermost/mattermost-webapp/tree/master/e2e/cypress/support (HTTP_404)
Line 2373: ├─BROKEN─ https://github.com/mattermost/mattermost-webapp/tree/master/e2e/cypress/support/api (HTTP_404)
Line 2395: ├─BROKEN─ https://github.com/mattermost/mattermost-cloud-monitoring/tree/master/terraform/aws/modules/pritunl (HTTP_404)
Line 2402: ├─BROKEN─ https://github.com/mattermost/mattermost-cloud-monitoring/tree/master/terraform/aws/modules/pritunl/userdata.sh (HTTP_404)
Line 2695: ├─BROKEN─ https://blogs.apache.org/infra/entry/subversion-to-git-service-git (HTTP_404)
Line 2759: ├─BROKEN─ https://developers.mattermost.com/integrate/plugins/server/reference/#API.GetBundlePath (HTTP_404)
Line 2761: ├─BROKEN─ https://developers.mattermost.com/integrate/plugins/server/reference/#Hooks.OnActivate (HTTP_404)
Line 542: ├─BROKEN─ https://docs.google.com/document/d/1qABE7VEx4k_ZAeh6Ydn4pGbu6BQfZt65x68i2s65MOQ
Possible Solutions
- Change that specific URL
- Remove broken links from docs
- Rewrite/remove text content where link mentioned.
- Activatate the URL // Set the redirection on that URL
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the listed URLs in the developer documentation source and verify each destination. Decide whether each broken reference should be replaced, removed, or have its surrounding text rewritten, then rerun the documentation link scan to confirm the reported broken links are resolved.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100