moja-global / moja_global_docs

Repository to host the moja global technical documentation
https://docs.moja.global/en/master/
Mozilla Public License 2.0
35 stars 67 forks source link

BugšŸ›: Fix broken links #151

Closed HarshCasper closed 2 years ago

HarshCasper commented 2 years ago

Describe the bug.

Run make linkcheck:

Running Sphinx v3.5.4
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [linkcheck]: targets for 64 source files that are out of date
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
preparing documents... done
writing output... [100%] prerequisites/visual_studio                                                                                                                                       

(DeveloperWorkflow/reviewing: line   26) broken    ../DevelopmentSetup/git_and_github_guide.html#make-a-contribution - 
(contributing/after_contribute: line   52) broken    ../DeveloperWorkflow/reviewing.html - 
(contributing/before_contribute: line    6) broken    ../DevelopmentSetup/git_and_github_guide.html - 
(DeveloperWorkflow/reviewing: line   31) broken    ../contributing/code_contribution_best_practices.html#commit-message-guidelines - 
(contributing/after_contribute: line   19) broken    ../DeveloperWorkflow/bots_and_integrations.html - 
(DeveloperWorkflow/reviewing: line   57) broken    ../contributing/code_contribution_best_practices.html#code-style-conventions - 
(DeveloperWorkflow/reviewing: line   69) broken    ../contributing/code_contribution_best_practices.html#writing-documentation - 
(contributing/before_contribute: line   15) broken    ../join-moja-global.html - 
(DevelopmentSetup/docker_installation: line   16) broken    ../prerequisites/docker.html - 
(DevelopmentSetup/visual_studio_example: line   15) broken    ../prerequisites/visual_studio.html - 
(DevelopmentSetup/visual_studio_win_example: line   13) broken    ../prerequisites/cmake.html - 
(             faq: line  258) broken    DevelopmentSetup/docker_installation.html - 
(             faq: line  246) broken    DevelopmentSetup/git_and_github_guide.html - 
(DevelopmentSetup/windows_installation: line   18) broken    ../prerequisites/vcpkg.html - 
(DevelopmentSetup/docker_installation: line   29) broken    FLINT.example_installation.html - 
(contributing/before_contribute: line    8) broken    coc.html - 
(contributing/before_contribute: line    9) broken    code_contribution_best_practices.html - 
(join-moja-global: line   69) broken    contributing/ways_to_contribute.html#organize-moja-global-events-meetups - 
(DevelopmentSetup/docker_installation: line    9) broken    git_and_github_guide.html#make-a-contribution - 
(join-moja-global: line   14) broken    contributing/ways_to_contribute.html#answer-user-questions - 
(join-moja-global: line    9) broken    contributing/coc.html - 
(DevelopmentSetup/FLINT.example_installation: line   39) broken    git_and_github_guide.html - 
(DevelopmentSetup/git_and_github_guide: line   58) broken    docker_installation.html - 
(env/lib/python3.8/site-packages/pytz-2021.1.dist-info/DESCRIPTION: line  552) ok        http://feeds.launchpad.net/pytz/announcements.atom
(env/lib/python3.8/site-packages/alabaster-0.7.12.dist-info/DESCRIPTION: line   11) redirect  http://alabaster.readthedocs.io - with Found to https://alabaster.readthedocs.io/en/latest/
(env/lib/python3.8/site-packages/pytz-2021.1.dist-info/DESCRIPTION: line  521) redirect  http://cldr.unicode.org - permanently to https://cldr.unicode.org/
(contributing/code_contribution_best_practices: line   83) redirect  http://clang.llvm.org/extra/clang-tidy/ - with Found to https://clang.llvm.org/extra/clang-tidy/
(env/lib/python3.8/site-packages/alabaster-0.7.12.dist-info/DESCRIPTION: line   11) redirect  http://fabfile.org - permanently to https://www.fabfile.org/
(env/lib/python3.8/site-packages/alabaster-0.7.12.dist-info/DESCRIPTION: line    4) redirect  http://sphinx-doc.org - with Found to https://www.sphinx-doc.org/en/master/
(env/lib/python3.8/site-packages/alabaster-0.7.12.dist-info/DESCRIPTION: line   11) redirect  http://pyinvoke.org - permanently to https://www.pyinvoke.org/
(env/lib/python3.8/site-packages/pytz-2021.1.dist-info/DESCRIPTION: line  587) broken    http://www.twinsun.com/tz/tz-link.htm - 404 Client Error: Not Found for url: http://www.twinsun.com/tz/tz-link.htm
(DeveloperWorkflow/bots_and_integrations: line   49) ok        https://allcontributors.org/docs/en/bot/configuration
(env/lib/python3.8/site-packages/pytz-2021.1.dist-info/DESCRIPTION: line  577) ok        http://www.iana.org/time-zones
(env/lib/python3.8/site-packages/alabaster-0.7.12.dist-info/DESCRIPTION: line   11) redirect  http://paramiko.org - permanently to https://www.paramiko.org/
(contributing/after_contribute: line   16) ok        https://allcontributors.org/docs/en/emoji-key
(env/lib/python3.8/site-packages/pytz-2021.1.dist-info/DESCRIPTION: line  561) ok        https://bugs.launchpad.net/pytz
(             faq: line   14) redirect  http://www.zdnet.com/article/coverity-finds-open-source-software-quality-better-than-proprietary-code/ - permanently to https://www.zdnet.com/article/coverity-finds-open-source-software-quality-better-than-proprietary-code/
(prerequisites/cmake: line   10) ok        https://cmake.org/download/
(join-moja-global: line   63) ok        https://community.moja.global/
(DeveloperWorkflow/automated_checks: line   90) ok        https://codeclimate.com/
(prerequisites/docker: line    6) ok        https://docs.docker.com/engine/install/
(prerequisites/docker: line   13) ok        https://docs.docker.com/engine/install/centos/
(prerequisites/docker: line   23) ok        https://docs.docker.com/engine/install/debian/
(prerequisites/docker: line   18) ok        https://docs.docker.com/engine/install/fedora/
(prerequisites/docker: line   28) ok        https://docs.docker.com/engine/install/ubuntu/
(join-moja-global: line   33) ok        https://developers.google.com/season-of-docs
(contributing/code_contribution_best_practices: line   41) ok        https://developercertificate.org/
(join-moja-global: line   33) redirect  https://developers.google.com/open-source/gsoc/ - with Found to https://summerofcode.withgoogle.com/
(DevelopmentSetup/index: line   56) ok        https://docs.google.com/document/d/139-1Nc5AR0yhN--Jb0W_jIfzUasoItkt4dyYM3m19N4/edit?usp=sharing
(             faq: line   51) ok        https://docs.google.com/document/d/15KY1CkCxRzB9ZBp68OLc2eWYuC5W-rqCKnTLaIG4tbg/edit?usp=sharing
(DeveloperWorkflow/automated_checks: line   19) redirect  https://codecov.io/ - permanently to https://about.codecov.io/
(DevelopmentSetup/index: line   58) ok        https://docs.google.com/document/d/185DrAQ9Tpg0XqwMt26ouzIDRKihJU0MZ2VUYX0L5Bys/edit?usp=sharing
(             faq: line   31) ok        https://docs.google.com/document/d/1Q2aVTzWchXQwupbEN7s37xANkPZvrLdfaFyYOT_8Diw/edit?usp=sharing
(contributing/code_contribution_best_practices: line  197) ok        https://docs.google.com/document/d/1feo9G91bbjth9RZ4606Rag4tAdRxuYpfnlWecs-gbbY/edit?usp=sharing
(DevelopmentSetup/index: line   54) ok        https://docs.google.com/document/d/1i6S0X0nTyxfJwn6KhGo9AahXOH1gBnTdwYdAxGchHsI/edit?usp=sharing
(DevelopmentSetup/index: line   55) ok        https://docs.google.com/document/d/1jceIX1E7HOmzmLW6C-E6GDbMz9sxM-nIy90CbY463Lw/edit?usp=sharing
(             faq: line  367) ok        https://docs.moja.global/projects/flint-reporting/en/latest/index.html
(             faq: line  345) ok        https://docs.moja.global/projects/flint-ui/en/latest/index.html
(prerequisites/git: line    6) ok        https://docs.moja.global/en/latest/prerequisites/cmake.html
(             faq: line  273) ok        https://docs.moja.global/en/latest/prerequisites/visual_studio.html#for-visual-studio-2019
(prerequisites/git: line   18) ok        https://docs.moja.global/en/latest/contributing/index.html
(env/lib/python3.8/site-packages/pytz-2021.1.dist-info/DESCRIPTION: line  434) ok        https://en.wikipedia.org/wiki/Coordinated_Universal_Time
(GCBMDevelopmentSetup/windows_installation: line   21) ok        https://docs.moja.global/en/master/GCBMDevelopmentSetup/prerequisites.html
(DocumentationStyleGuide/index: line   43) ok        https://en.wikipedia.org/wiki/Markdown#GitHub_Flavored_Markdown
(prerequisites/git: line   12) ok        https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
(DeveloperWorkflow/bots_and_integrations: line  215) ok        https://github.com/actions-ecosystem/action-create-comment
(DeveloperWorkflow/bots_and_integrations: line  244) ok        https://github.com/actions/first-interaction
(             faq: line  124) ok        https://flintpro.com/
(prerequisites/git: line   12) ok        https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup
(join-moja-global: line   97) redirect  https://forms.gle/ibH2XsaBSAeiyQcX7 - with Found to https://docs.google.com/forms/d/e/1FAIpQLSf_T7WEFPkxrnt3hFwJU6xfFijsqRrI0hp7FH12h-AiNWz_Fg/viewform?usp=send_form
(DeveloperWorkflow/bots_and_integrations: line   16) ok        https://github.com/all-contributors/all-contributors
(DeveloperWorkflow/bots_and_integrations: line  270) ok        https://github.com/andymckay/labeler
(DeveloperWorkflow/bots_and_integrations: line  278) broken    https://github.com/andymckay/labeler#complete-basic-usage - Anchor 'complete-basic-usage' not found
(DocumentationStyleGuide/style-tone: line   74) ok        https://github.com/andreasvc/readability/
(DeveloperWorkflow/bots_and_integrations: line   16) redirect  https://github.com/apps/allcontributors/installations/new - with Found to https://github.com/login?integration=allcontributors&return_to=%2Fapps%2Fallcontributors%2Finstallations%2Fnew
(DeveloperWorkflow/bots_and_integrations: line   63) redirect  https://github.com/apps/prosebot/installations/new - with Found to https://github.com/login?integration=prosebot&return_to=%2Fapps%2Fprosebot%2Finstallations%2Fnew
(DeveloperWorkflow/bots_and_integrations: line  141) ok        https://github.com/apps/stale
(DeveloperWorkflow/bots_and_integrations: line  122) redirect  https://github.com/apps/stale/installations/new - with Found to https://github.com/login?integration=stale&return_to=%2Fapps%2Fstale%2Finstallations%2Fnew
(DeveloperWorkflow/bots_and_integrations: line   99) ok        https://github.com/btford/write-good
(DeveloperWorkflow/bots_and_integrations: line  101) ok        https://github.com/atom/node-spellchecker
(DeveloperWorkflow/bots_and_integrations: line   75) broken    https://github.com/btford/write-good#checks - Anchor 'checks' not found
(DeveloperWorkflow/automated_checks: line   19) ok        https://github.com/features/actions
(prerequisites/git: line   16) ok        https://github.com/join
(DeveloperWorkflow/bots_and_integrations: line  100) ok        https://github.com/get-alex/alex
(DeveloperWorkflow/repository_maintenance: line   21) ok        https://github.com/moja-global
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   71) ok        https://github.com/lukasa
(             faq: line   65) redirect  https://github.com/moja-global/About-moja-global/wiki/moja-global-is-controlled-through-open-governance - permanently to https://github.com/moja-global/About_moja_global/wiki/moja-global-is-controlled-through-open-governance
(join-moja-global: line   60) ok        https://github.com/moja-global/
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   70) ok        https://github.com/haikuginger
(contributing/ways_to_contribute: line   57) redirect  https://github.com/moja-global/About_moja_global/issues/new/ - with Found to https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmoja-global%2FAbout_moja_global%2Fissues%2Fnew
(DevelopmentSetup/git_and_github_guide: line   20) ok        https://github.com/moja-global/FLINT
(DevelopmentSetup/FLINT.example_installation: line   30) ok        https://github.com/moja-global/FLINT.Example
(DeveloperWorkflow/automated_checks: line   11) ok        https://github.com/moja-global/FLINT.Data_Preprocessing
(             faq: line  398) ok        https://github.com/moja-global/GCBM.Visualisation_Tool
(DevelopmentSetup/visual_studio_win_example: line  308) redirect  https://github.com/moja-global/FLINT.chapman_richards - permanently to https://github.com/moja-global/FLINT.Module.Chapman_Richards
(DeveloperWorkflow/repository_maintenance: line   13) ok        https://github.com/moja-global/Import-Me
(DevelopmentSetup/index: line   26) ok        https://github.com/moja-global/Land_Sector_Datasets
(contributing/code_contribution_best_practices: line  163) ok        https://github.com/moja-global/moja_global_docs
(prerequisites/vcpkg: line   16) ok        https://github.com/moja-global/vcpkg
(DeveloperWorkflow/bots_and_integrations: line  215) ok        https://github.com/mschilde/auto-label-merge-conflicts
(DeveloperWorkflow/bots_and_integrations: line  122) ok        https://github.com/probot/probot
(DeveloperWorkflow/bots_and_integrations: line  122) ok        https://github.com/probot/stale
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   68) ok        https://github.com/pquentin
(DeveloperWorkflow/bots_and_integrations: line   63) ok        https://github.com/prosebot/prosebot
(env/lib/python3.8/site-packages/pytz-2021.1.dist-info/DESCRIPTION: line  550) ok        https://github.com/stub42/pytz
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   73) ok        https://github.com/shazow
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   36) ok        https://github.com/urllib3/urllib3
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   69) ok        https://github.com/theacodes
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   72) ok        https://github.com/sigmavirus24
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line  221) ok        https://github.com/urllib3/urllib3/issues/1850
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   67) ok        https://github.com/sethmlarson
(DevelopmentSetup/git_and_github_guide: line   69) ok        https://github.com/zulip/zulipbot/
(contributing/code_contribution_best_practices: line   76) ok        https://google.github.io/styleguide/cppguide.html
(DocumentationStyleGuide/index: line   43) ok        https://hackmd.io/
(           index: line   34) redirect  https://join.slack.com/t/mojaglobal/shared_invite/zt-o6ta1ug0-rVLjAo460~d7JbZ~HpFFtw - with Found to https://mojaglobal.slack.com/join/shared_invite/zt-o6ta1ug0-rVLjAo460~d7JbZ~HpFFtw
(env/lib/python3.8/site-packages/pytz-2021.1.dist-info/DESCRIPTION: line  552) ok        https://launchpad.net/pytz
(contributing/after_contribute: line   31) redirect  https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue - permanently to https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue
(DocumentationStyleGuide/index: line   43) ok        https://mdxjs.com/
(DevelopmentSetup/docker_installation: line   35) ok        https://hub.docker.com/r/mojaglobal/flint
(contributing/before_contribute: line   25) ok        https://moja-global.vercel.app/
(DevelopmentSetup/git_and_github_guide: line   77) ok        https://mojaglobal.slack.com
(DevelopmentSetup/visual_studio_example: line   16) ok        https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers
(             faq: line  290) ok        https://mojaglobal.slack.com/
(env/lib/python3.8/site-packages/pytz-2021.1.dist-info/DESCRIPTION: line  521) ok        https://pypi.org/project/l18n/
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   32) redirect  https://pip.pypa.io - with Found to https://pip.pypa.io/en/stable/
(env/lib/python3.8/site-packages/pytz-2021.1.dist-info/DESCRIPTION: line  542) ok        https://pypi.org/project/pytz/
(DevelopmentSetup/git_and_github_guide: line   14) ok        https://support.atlassian.com/bitbucket-cloud/docs/install-and-set-up-git/
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   88) ok        https://nedbatchelder.com/pix/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White_small.png
(env/lib/python3.8/site-packages/pytz-2021.1.dist-info/DESCRIPTION: line  567) ok        https://tidelift.com/security
(join-moja-global: line   62) ok        https://twitter.com/mojaglobal?lang=en
(env/lib/python3.8/site-packages/pytz-2021.1.dist-info/DESCRIPTION: line   53) ok        https://tidelift.com/subscription/pkg/pypi-pytz?utm_source=pypi-pytz&utm_medium=referral&utm_campaign=enterprise&utm_term=repo
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   96) ok        https://tidelift.com/subscription/pkg/pypi-urllib3?utm_source=pypi-urllib3&utm_medium=referral&utm_campaign=readme
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   45) redirect  https://urllib3.readthedocs.io - with Found to https://urllib3.readthedocs.io/en/stable/
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line 1275) redirect  https://urllib3.readthedocs.io/ - with Found to https://urllib3.readthedocs.io/en/stable/
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   51) ok        https://urllib3.readthedocs.io/en/latest/contributing.html
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line  894) redirect  https://urllib3.readthedocs.io/en/latest/security.html - with Found to https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line  142) ok        https://urllib3.readthedocs.io/en/latest/v2-roadmap.html
(prerequisites/visual_studio: line   16) ok        https://visualstudio.microsoft.com/downloads/
(prerequisites/visual_studio: line   57) ok        https://visualstudio.microsoft.com/vs/older-downloads/
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line  739) broken    https://urllib3.readthedocs.io/en/latest/contrib.html#google-app-engine - 404 Client Error: Not Found for url: https://urllib3.readthedocs.io/en/latest/contrib.html
(contributing/code_contribution_best_practices: line  122) redirect  https://medium.com/@andrewgoldis/how-to-document-source-code-responsibly-2b2f303aa525 - permanently to https://agoldis.medium.com/how-to-document-source-code-responsibly-2b2f303aa525
(env/lib/python3.8/site-packages/urllib3-1.26.4.dist-info/DESCRIPTION: line   81) ok        https://urllib3.readthedocs.io/en/latest/sponsors.html
(contributing/coc: line   93) redirect  https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - permanently to https://www.contributor-covenant.org/version/1/4/code-of-conduct/
(contributing/coc: line   97) ok        https://www.contributor-covenant.org/faq
(DocumentationStyleGuide/index: line   43) ok        https://www.google.com/docs/about/
(join-moja-global: line   33) broken    https://people.communitybridge.org/#projects - Anchor 'projects' not found
(join-moja-global: line   64) ok        https://www.google.com/url?q=https://join.slack.com/t/mojaglobal/shared_invite
(             faq: line   44) ok        https://www.mozilla.org/en-US/MPL/2.0/
(DocumentationStyleGuide/accessibility: line   83) ok        https://www.npmjs.com/package/broken-link-checker
(join-moja-global: line    9) ok        https://www.google.com/url?q=https://join.slack.com/t/mojaglobal/shared_invite/zt-o6ta1ug0-rVLjAo460~d7JbZ~HpFFtw&sa=D&source=editors&ust=1633078795555000&usg=AFQjCNFbieFLALt9IFd9pqxYz1S54wj-Rg
(join-moja-global: line   61) ok        https://www.linkedin.com/company/moja-global
(contributing/ways_to_contribute: line   93) broken    index.html#get-credit-for-your-contribution - 
(DeveloperWorkflow/reviewing: line   98) broken    manual_testing_pr.html - 
(contributing/after_contribute: line   59) broken    ways_to_contribute.html#answer-user-questions - 
(contributing/after_contribute: line   69) broken    ways_to_contribute.html#coach-or-train-new-contributors - 
(DevelopmentSetup/git_and_github_guide: line   58) broken    windows_installation.html - 
(contributing/code_contribution_best_practices: line   97) ok        https://www.python.org/dev/peps/pep-0008/
(contributing/code_contribution_best_practices: line  100) ok        https://www.pylint.org/
(join-moja-global: line   33) ok        https://www.outreachy.org/
(DocumentationStyleGuide/index: line   43) ok        https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
build finished with problems.
make: *** [linkcheck] Error 1

Describe the steps to reproduce the behavior.

No response

Expected behavior.

  1. Fix all the broken links (doing in batches is fine).
  2. Add a CI action to check for broken links on every push, PR and a cron job.
  3. Add relevant docs for users to check out broken links during development process.

Screenshots.

No response

Operating Environment

macOS, Python 3.8, Sphinx v3.5.4

Additional context.

No response

SanjaySinghRajpoot commented 2 years ago

I would like to work on this issue.

padmajabhol commented 2 years ago

Hi, is someone working on it? If not, I could like to take this up.