From af7afe327ed849044bc9a659d4b5444daedc21a8 Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Fri, 15 Nov 2019 13:11:02 -0500 Subject: [PATCH] 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 --- docs/conf.py | 5 +++++ ...ng-animal-sniffer-plugin-with-projects.rst | 2 +- docs/documentation.rst | 6 ++--- .../getting-started-guide/how-to-get-help.rst | 2 +- .../security_considerations.rst | 6 ++--- docs/javadoc.rst | 22 +++++++++---------- docs/release-notes/upgrade-process.rst | 6 ++--- docs/release-process/autorelease.rst | 4 ++-- docs/release-process/managed-release.rst | 2 +- .../user-guide/neutron-service-user-guide.rst | 2 +- tox.ini | 2 +- 11 files changed, 32 insertions(+), 27 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4c705ba6d..16f6f7346 100755 --- 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 413a0c91f..6ed4964aa 100644 --- 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 fa8da82ad..c9ea6ef25 100644 --- a/docs/documentation.rst +++ b/docs/documentation.rst @@ -567,7 +567,7 @@ Submitting Documentation Outlines (M2) git review - See the `Git-review Workflow `_ + See the `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 09c2f2338..68a737be2 100644 --- 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 `_. + `projects page `_. #. IRC: Connect to #opendaylight or #opendaylight-meeting channel on freenode. The `Linux Foundation's IRC guide `_ may be helpful. diff --git a/docs/getting-started-guide/security_considerations.rst b/docs/getting-started-guide/security_considerations.rst index 33f79eb8a..c20a5219f 100644 --- 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 53ba74073..8fc8d204e 100644 --- a/docs/javadoc.rst +++ b/docs/javadoc.rst @@ -5,18 +5,18 @@ Java API Documentation Release Integrated Projects =========================== -* `odlparent `_ -* `yangtools `_ -* `mdsal `_ +* `odlparent `_ +* `yangtools `_ +* `mdsal `_ Managed Projects ================ -* `bgpcep `_ -* `genius `_ -* `infrautils `_ -* `lispflowmapping `_ -* `netvirt `_ -* `neutron `_ -* `openflowplugin `_ -* `ovsdb `_ +* `bgpcep `_ +* `genius `_ +* `infrautils `_ +* `lispflowmapping `_ +* `netvirt `_ +* `neutron `_ +* `openflowplugin `_ +* `ovsdb `_ diff --git a/docs/release-notes/upgrade-process.rst b/docs/release-notes/upgrade-process.rst index 28c68b257..d9ebd3ac6 100644 --- a/docs/release-notes/upgrade-process.rst +++ b/docs/release-notes/upgrade-process.rst @@ -4,7 +4,7 @@ Aluminium Platform Upgrade This document describes the steps to help users upgrade to the Magnesium planned platform. Refer to `Managed Release Integrated (MRI) -project `_ +project `_ upgrade patches for more information. .. contents:: Contents @@ -65,7 +65,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 `_ changes for any dependent project. +pull and install the respective `magnesium-mri `_ changes for any dependent project. Perform the following steps to save time when locally installing any dependent project: @@ -87,7 +87,7 @@ Upgrade the ODL Parent ---------------------- The following sub-section describes how to upgrade to the ODL Parent version 4. Refer to the `ODL Parent Release Notes -`_ +`_ for more information. Features diff --git a/docs/release-process/autorelease.rst b/docs/release-process/autorelease.rst index e880a69eb..7b2b6ceb1 100644 --- a/docs/release-process/autorelease.rst +++ b/docs/release-process/autorelease.rst @@ -3,11 +3,11 @@ Autorelease *********** The Release Engineering - `Autorelease project -`_ +`_ is targeted at building the artifacts that are used in the release candidates and final full release. -* `Open Gerrit Patches `_ +* `Open Gerrit Patches `_ * `Jenkins Jobs `_ Cloning Autorelease diff --git a/docs/release-process/managed-release.rst b/docs/release-process/managed-release.rst index 920c26084..2ca11c332 100644 --- 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 d1aa056a2..e0e75ff9a 100644 --- 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 ced2d82c4..01a779e43 100644 --- 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] -- 2.36.6