Merge pull request #1909 from AyanSinhaMahapatra/fix-links-md

Fix broken links and Add awesome_bot linkcheck

Author: pombredanne

.github/ISSUE_TEMPLATE/--first-timers-only.md

@@ -20,7 +20,7 @@ docs.
 
 ### A first-timer's Issue
 
-A [first-timers-only issue](https://github.com/nexB/scancode-toolkit/labels/%20first%20timers%20only)
+A [first-timers-only issue](https://github.com/nexB/scancode-toolkit/labels/first%20timers%20only)
 means we've worked to make it more legible to folks who either **haven't contributed to our codebase before,
 or even folks who haven't contributed to open source before**. 
 
@@ -63,7 +63,7 @@ If this happens to you, don't sweat it! Grab another open issue.
 easily see if someone's already started on it. 
 
 👥- **If someone seems stuck, offer them some help!** Otherwise,
-[take a look at some other issues you can help with](https://github.com/nexB/scancode-toolkit/labels/%20first%20timers%20only).
+[take a look at some other issues you can help with](https://github.com/nexB/scancode-toolkit/labels/20first%20timers%20only).
 Thanks!
 
 ### 🤔❓ Questions?
@@ -92,7 +92,7 @@ This task list makes it easier for the maintainers to track your Progress, so up
 
 - [ ] **Review Guidelines** Check out our Code of Conduct and Contributing Guidelines before you start working. 
 
-- [ ] **Refer Documentation** Refer [docuementation](https://aboutcode.readthedocs.io/en/latest/scancode-toolkit/contribute/contrib_doc.html)
+- [ ] **Refer Documentation** Refer [docuementation](https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_doc.html)
   for more help on the contribution process and to understand our Sphinx and reStructuredText built
   documentation generation better.
 

.github/ISSUE_TEMPLATE/--good-first-issue.md

@@ -63,7 +63,7 @@ Make sure all these boxes are checked before your pull request (PR) is ready to
 - [ ] 📝 **Code your Solution**
 
 - [ ] 📝 **Run the tests locally**
-  Refer [Documentation](https://aboutcode.readthedocs.io/en/latest/scancode-toolkit/contribute/contrib_dev.html#running-tests)
+  Refer [Documentation](https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_dev.html#running-tests)
 
 - [ ] 💾 **Commit and Push** your changes. Do check out this documentation on 
   [writing good commit messages](https://aboutcode.readthedocs.io/en/latest/aboutcode-docs/writing_good_commit_messages.html) 

.github/PULL_REQUEST_TEMPLATE.md

@@ -15,7 +15,7 @@ Make sure these boxes are checked before your pull request (PR) is ready to be r
 * [ ] Reviewed [contribution guidelines](https://github.com/nexB/scancode-toolkit/blob/develop/CONTRIBUTING.rst)
 * [ ] PR is descriptively titled 📑 and links the original issue above 🔗
 * [ ] Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
-  Run [tests](https://aboutcode.readthedocs.io/en/latest/scancode-toolkit/contribute/contrib_dev.html#running-tests) locally to check for errors. 
+  Run [tests](https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_dev.html#running-tests) locally to check for errors. 
 * [ ] Commits are in uniquely-named feature branch and has no merge conflicts 📁
 
 <!--

.travis.yml

@@ -78,17 +78,37 @@ matrix:
       python: "3.6"
       dist: bionic
 
+    # Refer https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_doc.html#continuous-integration
     - os: linux
       sudo: required
       script: 
         - source bin/activate
         - cd docs
+        # This script tests the Sphinx Documentation build
+        # Also checks for broken links in the documentation
         - ./scripts/sphinx_build_link_check.sh
+        # This script checks for documentation style errors
         - ./scripts/doc8_style_check.sh
       language: python
       python: "3.6"
       dist: bionic
 
+    # Refer https://github.com/dkhamsing/awesome_bot#command-line for more info.
+    - os: linux
+      sudo: required
+      before_install:
+        - gem install awesome_bot
+      script:
+        # These check for broken links inside .md files used for GitHub templates
+        - awesome_bot .github/*.md --allow-redirect --allow-dupe --skip-save-results
+        - awesome_bot .github/ISSUE_TEMPLATE/*.md --allow-redirect --allow-dupe --skip-save-results
+        # This checks for broken links inside .rst files at Project Root, like README.rst
+        - awesome_bot *.rst --allow-redirect --allow-dupe --skip-save-results
+        # This checks for broken links inside README.md files of plugins/plugins-builtin folders.
+        - awesome_bot */**/*.md --allow-redirect --allow-dupe --skip-save-results
+        # This checks for broken links inside Thirdparty .ABOUT files
+        - awesome_bot */*.ABOUT --allow-redirect --allow-dupe --skip-save-results
+
 addons:
   homebrew:
     packages:

CONTRIBUTING.rst

@@ -5,8 +5,8 @@ Contributing
 Contributions are welcome and appreciated!
 Every little bit helps, and credit will always be given.
 
-.. _issue : https://github.com/nexB/scancode-toolkit/issue
-__ issue_
+.. _issues : https://github.com/nexB/scancode-toolkit/issues
+__ issues_
 
 If you are new to ScanCode and want to find easy tickets to work on,
 check `easy issues <https://github.com/nexB/scancode-toolkit/labels/easy>`_

thirdparty/psutil-5.6.2-cp27-cp27m-linux_x86_64.whl.ABOUT

@@ -1,7 +1,7 @@
 about_resource: psutil-5.6.2-cp27-cp27m-linux_x86_64.whl
 name: psutil
 version: 5.6.2
-download_url: https://github.com/nexB/scancode-toolkit/raw/295-tests-and-setup/thirdparty/psutil-5.6.2-cp27-cp27m-linux_x86_64.whl
+download_url: https://github.com/nexB/scancode-toolkit/blob/develop/thirdparty/psutil-5.6.2-cp27-cp27m-linux_x86_64.whl
 description: Cross-platform lib for process and system monitoring in Python
 homepage_url: https://github.com/giampaolo/psutil
 license_expression: bsd-new

thirdparty/psutil-5.6.2-cp36-cp36m-linux_x86_64.whl.ABOUT

@@ -1,7 +1,7 @@
 about_resource: psutil-5.6.2-cp36-cp36m-linux_x86_64.whl
 name: psutil
 version: 5.6.2
-download_url: https://github.com/nexB/scancode-toolkit/raw/295-tests-and-setup/thirdparty/psutil-5.6.2-cp36-cp36m-linux_x86_64.whl
+download_url: https://github.com/nexB/scancode-toolkit/blob/develop/thirdparty/psutil-5.6.2-cp36-cp36m-linux_x86_64.whl
 description: Cross-platform lib for process and system monitoring in Python
 homepage_url: https://github.com/giampaolo/psutil
 license_expression: bsd-new

thirdparty/publicsuffix2-2.20180921-py2.py3-none-any.whl.ABOUT

@@ -22,7 +22,7 @@ licenses:
     name: Mozilla Public License 2.0
 name: publicsuffix2
 notice_file: publicsuffix2-2.20180921-py2.py3-none-any.whl.NOTICE
-notice_url: https://github.com/nexB/python-publicsuffix2/blob/develop/publicsuffix.LICENSE
+notice_url: https://github.com/nexB/python-publicsuffix2/blob/develop/src/publicsuffix2/mpl-2.0.LICENSE
 owner: nexB
 owner_url: http://www.nexb.com/
 redistribute: true

thirdparty/py2-ipaddress-3.4.1.tar.gz.ABOUT

@@ -8,7 +8,7 @@ description: Python 2.7 backport of the Python 3.3 ipaddress module. Not all 3.3
     is supported, due to the lack of a distinct bytes type in Python 2.7. Nevertheless,
     it is quite useful if you're stuck with Python 2.7.
 download_url: https://files.pythonhosted.org/packages/06/f2/ff20f2d2fd4757be329c8ecb81e9e7fa3bec0b65445821e3a575410cf194/py2-ipaddress-3.4.1.tar.gz
-homepage_url: https://bitbucket.org/kwi/py2-ipaddress
+homepage_url: https://github.com/kwi-dk/py2-ipaddress
 license_expression: python AND public-domain
 licenses:
 -   file: public-domain.LICENSE
@@ -23,5 +23,5 @@ notice_file: py2-ipaddress-3.4.1.tar.gz.NOTICE
 owner: Google
 owner_url: http://www.google.com/intl/en/about/index.html
 track_changes: true
-vcs_url: https://bitbucket.org/kwi/py2-ipaddress
+vcs_url: https://github.com/kwi-dk/py2-ipaddress
 version: 3.4.1

thirdparty/py2_ipaddress-3.4.1-py2-none-any.whl.ABOUT

@@ -6,7 +6,7 @@ description: Python 2.7 backport of the Python 3.3 ipaddress module. Not all 3.3
     is supported, due to the lack of a distinct bytes type in Python 2.7. Nevertheless,
     it is quite useful if you're stuck with Python 2.7.
 download_url: https://files.pythonhosted.org/packages/06/f2/ff20f2d2fd4757be329c8ecb81e9e7fa3bec0b65445821e3a575410cf194/py2-ipaddress-3.4.1.tar.gz
-homepage_url: https://bitbucket.org/kwi/py2-ipaddress
+homepage_url: https://github.com/kwi-dk/py2-ipaddress
 license_expression: python AND public-domain
 licenses:
 -   file: public-domain.LICENSE
@@ -21,5 +21,5 @@ notice_file: py2-ipaddress-3.4.1.tar.gz.NOTICE
 owner: Google
 owner_url: http://www.google.com/intl/en/about/index.html
 track_changes: true
-vcs_url: https://bitbucket.org/kwi/py2-ipaddress
+vcs_url: https://github.com/kwi-dk/py2-ipaddress
 version: 3.4.1