Enable docs-linkcheck to validate the links

This patch enables the linkchecker to run against links in the docs.
It also takes care of broken links that were detected as part of this
work.

Issue: DOCS-40
Change-Id: I7fff59927b2d88b2e9feefc175068d9cd45cedc6
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

diff --git a/docs/conf.py b/docs/conf.py
index f5f8d691d855998fc057d75c54725d0130c98680..8e3423710fbb40d261aaf98901b04f8800b3d669 100755 (executable)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -53,7 +53,12 @@ linkcheck_ignore = [
     # The '#' in the path makes sphinx think it's an anchor
     'https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder',
     'https://git.opendaylight.org/gerrit/gitweb',
+    # URL returns a 403 Forbidden
+    'https://www.osgi.org',
+    # Ignore anchors on github.com because linkcheck fails on them
+    '^http[s]://github.com/.*#',
 ]
+linkcheck_timeout = 300
 
 nitpicky = True
 release = version

diff --git a/docs/developer-guide/integrating-animal-sniffer-plugin-with-projects.rst b/docs/developer-guide/integrating-animal-sniffer-plugin-with-projects.rst
index 413a0c91fc129e450828607e2ce4a73adc1652a2..6ed4964aa490a80c9af90926d8b4e51dd56cb605 100644 (file)
--- a/docs/developer-guide/integrating-animal-sniffer-plugin-with-projects.rst
+++ b/docs/developer-guide/integrating-animal-sniffer-plugin-with-projects.rst
@@ -93,4 +93,4 @@ Steps to setup up animal sniffer plugin with your project
 
 .. _odlparent gerrit patch: https://git.opendaylight.org/gerrit/64688/
 .. _yangtools gerrit patch: https://git.opendaylight.org/gerrit/64781
-.. _Animal Sniffer plugin: http://www.mojohaus.org/animal-sniffer/animal-sniffer-maven-plugin/examples/checking-signatures.html
+.. _Animal Sniffer plugin: https://www.mojohaus.org/animal-sniffer/animal-sniffer-maven-plugin/examples/checking-signatures.html

diff --git a/docs/documentation.rst b/docs/documentation.rst
index fa8da82ad00bf91cc7adef4ade74eec2f74ae4cb..c9ea6ef258460990d05ca24fd1e927eca30bf0ba 100644 (file)
--- a/docs/documentation.rst
+++ b/docs/documentation.rst
@@ -567,7 +567,7 @@ Submitting Documentation Outlines (M2)
 
          git review
 
-      See the `Git-review Workflow <https://wiki.opendaylight.org/view/Git-review_Workflow>`_
+      See the `Git-review Workflow <https://wiki-archive.opendaylight.org/view/Git-review_Workflow>`_
       page if you don't have git-review installed.
 
 #. Wait for the patch to be merged or to get feedback
@@ -761,6 +761,6 @@ Timeline for Deliverables from Projects
 
 .. _Sphinx: http://www.sphinx-doc.org/en/stable/
 .. _reStructuredText: http://www.sphinx-doc.org/en/stable/rest.html
-.. _Documentation Group: https://wiki.opendaylight.org/view/Documentation/
-.. _RelEng/Builder: https://wiki.opendaylight.org/view/RelEng/Builder
+.. _Documentation Group: https://wiki-archive.opendaylight.org/view/Documentation/
+.. _RelEng/Builder: https://wiki-archive.opendaylight.org/view/RelEng/Builder
 .. _Pandoc: http://pandoc.org/

diff --git a/docs/getting-started-guide/how-to-get-help.rst b/docs/getting-started-guide/how-to-get-help.rst
index 09c2f2338ae1b006deb5350bd059f37342319938..68a737be2605781086a4caedfdc20cc86ec705e3 100644 (file)
--- a/docs/getting-started-guide/how-to-get-help.rst
+++ b/docs/getting-started-guide/how-to-get-help.rst
@@ -15,7 +15,7 @@ mailing lists, IRC and forums.
 #. Mail discuss@lists.opendaylight.org or dev@lists.opendaylight.org.
 
 #. Directly mail the PTL as indicated on the specific
-   `projects page <https://wiki.opendaylight.org/view/Project_list>`_.
+   `projects page <https://wiki-archive.opendaylight.org/view/Project_list>`_.
 
 #. IRC: Connect to #opendaylight or #opendaylight-meeting channel on freenode.
    The `Linux Foundation's IRC guide <https://docs.releng.linuxfoundation.org/en/latest/freenode.html>`_ may be helpful.

diff --git a/docs/getting-started-guide/security_considerations.rst b/docs/getting-started-guide/security_considerations.rst
index 33f79eb8aa517ea80fe29946fff4ddd0a863392c..c20a5219f1c814641798ee3441b192d0c2343313 100644 (file)
--- a/docs/getting-started-guide/security_considerations.rst
+++ b/docs/getting-started-guide/security_considerations.rst
@@ -68,10 +68,10 @@ OpenDaylight Security Resources
 
 * For the list of current OpenDaylight security issues that are either being
   fixed or resolved, refer to
-  https://wiki.opendaylight.org/view/Security:Advisories.
+  https://wiki-archive.opendaylight.org/view/Security:Advisories.
 
 * To learn more about the OpenDaylight security issues policies and procedure,
-  refer to https://wiki.opendaylight.org/view/Security:Main
+  refer to https://wiki-archive.opendaylight.org/view/Security:Main
 
 .. _security_deployment_recommendations:
 
@@ -131,7 +131,7 @@ security model to add the following features:
   OSGi core and can be obtained from the OSGi service registry. The
   *ConditionalPermissionAdmin* API replaces the earlier *PermissionAdmin* API.
 
-For more information, refer to http://www.osgi.org/Main/HomePage.
+For more information, refer to https://www.osgi.org
 
 .. _securing-karaf:
 

diff --git a/docs/javadoc.rst b/docs/javadoc.rst
index 0175d988a04fcdaf3b16bbd2715c3a114008870e..aa192e0a486e4e346c7868a9612435291cf7ca53 100644 (file)
--- a/docs/javadoc.rst
+++ b/docs/javadoc.rst
@@ -5,9 +5,9 @@ Java API Documentation
 Release Integrated Projects
 ===========================
 
-* `odlparent <https://javadocs.opendaylight.org/odlparent>`_
-* `yangtools <https://javadocs.opendaylight.org/yangtools>`_
-* `mdsal <https://javadocs.opendaylight.org/mdsal>`_
+* `odlparent <https://javadoc.io/doc/org.opendaylight.odlparent>`_
+* `yangtools <https://javadoc.io/doc/org.opendaylight.yangtools>`_
+* `mdsal <https://javadoc.io/doc/org.opendaylight.mdsal>`_
 
 Managed Projects
 ================

diff --git a/docs/release-notes/upgrade-process.rst b/docs/release-notes/upgrade-process.rst
index 1aa1372872d34ea43282d7f80dea95358379092c..71419f856800c6242ae76b72ce6cd943875be0d2 100644 (file)
--- a/docs/release-notes/upgrade-process.rst
+++ b/docs/release-notes/upgrade-process.rst
@@ -4,7 +4,7 @@ Magnesium Platform Upgrade
 
 This document describes the steps to help users upgrade to the
 Magnesium planned platform. Refer to `Managed Release Integrated (MRI)
-project <https://git.opendaylight.org/gerrit/#/q/topic:magnesium-mri>`_
+project <https://git.opendaylight.org/gerrit/q/topic:magnesium-mri>`_
 for more information.
 
 .. contents:: Contents
@@ -58,7 +58,7 @@ Install Dependent Projects
 
 Before performing platform upgrade, users must also install
 any dependent project. To locally install a dependent project,
-pull and install the respective `magnesium-mri <https://git.opendaylight.org/gerrit/#/q/topic:magnesium-mri>`_ changes for any dependent project. At the minimum, pull and install *controller*.
+pull and install the respective `magnesium-mri <https://git.opendaylight.org/gerrit/q/topic:magnesium-mri>`_ changes for any dependent project. At the minimum, pull and install *controller*.
 
 Perform the following steps to save time when locally installing
 any dependent project:
@@ -106,7 +106,7 @@ in Java versions 9-11, such as VarHandles, StackWalker, Cleaner, etc. Note
 that installing Java 11 removes several components (refer to, `JEP 320
 <https://openjdk.java.net/jeps/320>`_. A summary of the API
 differences can be found in the java-almanac project (refer to, `Java API
-<http://download.eclipselab.org/jdkdiff/V8/V11/index.html>`_.
+<https://javaalmanac.io/jdk/11/apidiff/8/>`_.
 
 Furthermore, Java 9 switched the default garbage collector to `G1GC
 <https://openjdk.java.net/jeps/248>`_ with `improvements

diff --git a/docs/release-process/autorelease.rst b/docs/release-process/autorelease.rst
index e880a69ebacc386767789b9f6ca4b66bbe96547e..7b2b6ceb1ab22b8a644f8f19f95319333c2f8307 100644 (file)
--- a/docs/release-process/autorelease.rst
+++ b/docs/release-process/autorelease.rst
@@ -3,11 +3,11 @@ Autorelease
 ***********
 
 The Release Engineering - `Autorelease project
-<https://wiki.opendaylight.org/view/RelEng/Autorelease>`_
+<https://wiki-archive.opendaylight.org/view/RelEng/Autorelease>`_
 is targeted at building the artifacts that are used in the release candidates
 and final full release.
 
-* `Open Gerrit Patches <https://git.opendaylight.org/gerrit/#/q/project:releng/autorelease+status:open>`_
+* `Open Gerrit Patches <https://git.opendaylight.org/gerrit/q/project:releng/autorelease+status:open>`_
 * `Jenkins Jobs <https://jenkins.opendaylight.org/releng/view/autorelease/>`_
 
 Cloning Autorelease

diff --git a/docs/release-process/managed-release.rst b/docs/release-process/managed-release.rst
index 920c26084de0ce2fedb0ce3ffb626b7063e59e10..2ca11c33288f4cf669a84948c727851146a0f0b3 100644 (file)
--- a/docs/release-process/managed-release.rst
+++ b/docs/release-process/managed-release.rst
@@ -720,5 +720,5 @@ Vocabulary Reference
   Simultaneous Release. These projects are consumed by Snapshot Integrated
   Projects based on release version numbers, not snapshot versions.
 
-.. _Committer Removal Process: https://wiki.opendaylight.org/view/TSC:Main#Committer_Removal_Process
+.. _Committer Removal Process: https://wiki-archive.opendaylight.org/view/TSC:Procedures_and_Processes#Committer_Removal_Process
 .. _Weather Page: https://jira.opendaylight.org/browse/TSC-132?jql=Project%20%3D%20TSC%20AND%20Type%20%3D%20%22Weather%20Item%22%20

diff --git a/docs/user-guide/neutron-service-user-guide.rst b/docs/user-guide/neutron-service-user-guide.rst
index d1aa056a27a49ac563efcea655090a60199ef923..e0e75ff9a741dce2f1f526f0eafb0fd2a80a79dd 100644 (file)
--- a/docs/user-guide/neutron-service-user-guide.rst
+++ b/docs/user-guide/neutron-service-user-guide.rst
@@ -18,7 +18,7 @@ documentations of each component:
 
 -  http://git.openstack.org/cgit/openstack/networking-odl/
 
--  https://wiki.opendaylight.org/view/NeutronNorthbound:Main
+-  https://wiki-archive.opendaylight.org/view/NeutronNorthbound:Main
 
 Use cases and who will use the feature
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/tox.ini b/tox.ini
index ced2d82c49c8a3b7050f1978d80697e2fe15fd88..01a779e433519aa212f7990ef9121189f46e9437 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -1,6 +1,6 @@
 [tox]
 minversion = 1.6
-envlist = pre-commit,docs
+envlist = pre-commit,docs,docs-linkcheck
 skipsdist = true
 
 [testenv:docs]